nsswitch/libwbclient/wbclient.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Winbind client API
   5
   6    Copyright (C) Gerald (Jerry) Carter 2007
   7
   8    This library is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU Lesser General Public
  10    License as published by the Free Software Foundation; either
  11    version 3 of the License, or (at your option) any later version.
  12
  13    This library is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    Library General Public License for more details.
  17
  18    You should have received a copy of the GNU Lesser General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef _WBCLIENT_H
  23 #define _WBCLIENT_H
  24
  25 #include <pwd.h>
  26 #include <grp.h>
  27
  28 /* Define error types */
  29
  30 /**
  31  *  @brief Status codes returned from wbc functions
  32  **/
  33
  34 enum _wbcErrType {
  35         WBC_ERR_SUCCESS = 0,    /**< Successful completion **/
  36         WBC_ERR_NOT_IMPLEMENTED,/**< Function not implemented **/
  37         WBC_ERR_UNKNOWN_FAILURE,/**< General failure **/
  38         WBC_ERR_NO_MEMORY,      /**< Memory allocation error **/
  39         WBC_ERR_INVALID_SID,    /**< Invalid SID format **/
  40         WBC_ERR_INVALID_PARAM,  /**< An Invalid parameter was supplied **/
  41         WBC_ERR_WINBIND_NOT_AVAILABLE,   /**< Winbind daemon is not available **/
  42         WBC_ERR_DOMAIN_NOT_FOUND,        /**< Domain is not trusted or cannot be found **/
  43         WBC_ERR_INVALID_RESPONSE,        /**< Winbind returned an invalid response **/
  44         WBC_ERR_NSS_ERROR,            /**< NSS_STATUS error **/
  45         WBC_ERR_AUTH_ERROR,        /**< Authentication failed **/
  46         WBC_ERR_UNKNOWN_USER,      /**< User account cannot be found */
  47         WBC_ERR_UNKNOWN_GROUP,     /**< Group account cannot be found */
  48         WBC_ERR_PWD_CHANGE_FAILED  /**< Password Change has failed */
  49 };
  50
  51 typedef enum _wbcErrType wbcErr;
  52
  53 #define WBC_ERROR_IS_OK(x) ((x) == WBC_ERR_SUCCESS)
  54
  55 const char *wbcErrorString(wbcErr error);
  56
  57 /**
  58  *  @brief Some useful details about the wbclient library
  59  *
  60  *  0.1: Initial version
  61  *  0.2: Added wbcRemoveUidMapping()
  62  *       Added wbcRemoveGidMapping()
  63  *  0.3: Added wbcGetpwsid()
  64  *       Added wbcGetSidAliases()
  65  *  0.4: Added wbcSidTypeString()
  66  **/
  67 #define WBCLIENT_MAJOR_VERSION 0
  68 #define WBCLIENT_MINOR_VERSION 4
  69 #define WBCLIENT_VENDOR_VERSION "Samba libwbclient"
  70 struct wbcLibraryDetails {
  71         uint16_t major_version;
  72         uint16_t minor_version;
  73         const char *vendor_version;
  74 };
  75
  76 /**
  77  *  @brief Some useful details about the running winbindd
  78  *
  79  **/
  80 struct wbcInterfaceDetails {
  81         uint32_t interface_version;
  82         const char *winbind_version;
  83         char winbind_separator;
  84         const char *netbios_name;
  85         const char *netbios_domain;
  86         const char *dns_domain;
  87 };
  88
  89 /*
  90  * Data types used by the Winbind Client API
  91  */
  92
  93 #ifndef WBC_MAXSUBAUTHS
  94 #define WBC_MAXSUBAUTHS 15 /* max sub authorities in a SID */
  95 #endif
  96
  97 /**
  98  *  @brief Windows Security Identifier
  99  *
 100  **/
 101
 102 struct wbcDomainSid {
 103         uint8_t   sid_rev_num;
 104         uint8_t   num_auths;
 105         uint8_t   id_auth[6];
 106         uint32_t  sub_auths[WBC_MAXSUBAUTHS];
 107 };
 108
 109 /**
 110  * @brief Security Identifier type
 111  **/
 112
 113 enum wbcSidType {
 114         WBC_SID_NAME_USE_NONE=0,
 115         WBC_SID_NAME_USER=1,
 116         WBC_SID_NAME_DOM_GRP=2,
 117         WBC_SID_NAME_DOMAIN=3,
 118         WBC_SID_NAME_ALIAS=4,
 119         WBC_SID_NAME_WKN_GRP=5,
 120         WBC_SID_NAME_DELETED=6,
 121         WBC_SID_NAME_INVALID=7,
 122         WBC_SID_NAME_UNKNOWN=8,
 123         WBC_SID_NAME_COMPUTER=9
 124 };
 125
 126 /**
 127  * @brief Security Identifier with attributes
 128  **/
 129
 130 struct wbcSidWithAttr {
 131         struct wbcDomainSid sid;
 132         uint32_t attributes;
 133 };
 134
 135 /* wbcSidWithAttr->attributes */
 136
 137 #define WBC_SID_ATTR_GROUP_MANDATORY            0x00000001
 138 #define WBC_SID_ATTR_GROUP_ENABLED_BY_DEFAULT   0x00000002
 139 #define WBC_SID_ATTR_GROUP_ENABLED              0x00000004
 140 #define WBC_SID_ATTR_GROUP_OWNER                0x00000008
 141 #define WBC_SID_ATTR_GROUP_USEFOR_DENY_ONLY     0x00000010
 142 #define WBC_SID_ATTR_GROUP_RESOURCE             0x20000000
 143 #define WBC_SID_ATTR_GROUP_LOGON_ID             0xC0000000
 144
 145 /**
 146  *  @brief Windows GUID
 147  *
 148  **/
 149
 150 struct wbcGuid {
 151         uint32_t time_low;
 152         uint16_t time_mid;
 153         uint16_t time_hi_and_version;
 154         uint8_t clock_seq[2];
 155         uint8_t node[6];
 156 };
 157
 158 /**
 159  * @brief Domain Information
 160  **/
 161
 162 struct wbcDomainInfo {
 163         char *short_name;
 164         char *dns_name;
 165         struct wbcDomainSid sid;
 166         uint32_t domain_flags;
 167         uint32_t trust_flags;
 168         uint32_t trust_type;
 169 };
 170
 171 /* wbcDomainInfo->domain_flags */
 172
 173 #define WBC_DOMINFO_DOMAIN_UNKNOWN    0x00000000
 174 #define WBC_DOMINFO_DOMAIN_NATIVE     0x00000001
 175 #define WBC_DOMINFO_DOMAIN_AD         0x00000002
 176 #define WBC_DOMINFO_DOMAIN_PRIMARY    0x00000004
 177 #define WBC_DOMINFO_DOMAIN_OFFLINE    0x00000008
 178
 179 /* wbcDomainInfo->trust_flags */
 180
 181 #define WBC_DOMINFO_TRUST_TRANSITIVE  0x00000001
 182 #define WBC_DOMINFO_TRUST_INCOMING    0x00000002
 183 #define WBC_DOMINFO_TRUST_OUTGOING    0x00000004
 184
 185 /* wbcDomainInfo->trust_type */
 186
 187 #define WBC_DOMINFO_TRUSTTYPE_NONE       0x00000000
 188 #define WBC_DOMINFO_TRUSTTYPE_FOREST     0x00000001
 189 #define WBC_DOMINFO_TRUSTTYPE_IN_FOREST  0x00000002
 190 #define WBC_DOMINFO_TRUSTTYPE_EXTERNAL   0x00000003
 191
 192
 193 /**
 194  * @brief Auth User Parameters
 195  **/
 196
 197 struct wbcAuthUserParams {
 198         const char *account_name;
 199         const char *domain_name;
 200         const char *workstation_name;
 201
 202         uint32_t flags;
 203
 204         uint32_t parameter_control;
 205
 206         enum wbcAuthUserLevel {
 207                 WBC_AUTH_USER_LEVEL_PLAIN = 1,
 208                 WBC_AUTH_USER_LEVEL_HASH = 2,
 209                 WBC_AUTH_USER_LEVEL_RESPONSE = 3
 210         } level;
 211         union {
 212                 const char *plaintext;
 213                 struct {
 214                         uint8_t nt_hash[16];
 215                         uint8_t lm_hash[16];
 216                 } hash;
 217                 struct {
 218                         uint8_t challenge[8];
 219                         uint32_t nt_length;
 220                         uint8_t *nt_data;
 221                         uint32_t lm_length;
 222                         uint8_t *lm_data;
 223                 } response;
 224         } password;
 225 };
 226
 227 /**
 228  * @brief Generic Blob
 229  **/
 230
 231 struct wbcBlob {
 232         uint8_t *data;
 233         size_t length;
 234 };
 235
 236 /**
 237  * @brief Named Blob
 238  **/
 239
 240 struct wbcNamedBlob {
 241         const char *name;
 242         uint32_t flags;
 243         struct wbcBlob blob;
 244 };
 245
 246 /**
 247  * @brief Logon User Parameters
 248  **/
 249
 250 struct wbcLogonUserParams {
 251         const char *username;
 252         const char *password;
 253         size_t num_blobs;
 254         struct wbcNamedBlob *blobs;
 255 };
 256
 257 /**
 258  * @brief ChangePassword Parameters
 259  **/
 260
 261 struct wbcChangePasswordParams {
 262         const char *account_name;
 263         const char *domain_name;
 264
 265         uint32_t flags;
 266
 267         enum wbcChangePasswordLevel {
 268                 WBC_CHANGE_PASSWORD_LEVEL_PLAIN = 1,
 269                 WBC_CHANGE_PASSWORD_LEVEL_RESPONSE = 2
 270         } level;
 271
 272         union {
 273                 const char *plaintext;
 274                 struct {
 275                         uint32_t old_nt_hash_enc_length;
 276                         uint8_t *old_nt_hash_enc_data;
 277                         uint32_t old_lm_hash_enc_length;
 278                         uint8_t *old_lm_hash_enc_data;
 279                 } response;
 280         } old_password;
 281         union {
 282                 const char *plaintext;
 283                 struct {
 284                         uint32_t nt_length;
 285                         uint8_t *nt_data;
 286                         uint32_t lm_length;
 287                         uint8_t *lm_data;
 288                 } response;
 289         } new_password;
 290 };
 291
 292 /* wbcAuthUserParams->parameter_control */
 293
 294 #define WBC_MSV1_0_CLEARTEXT_PASSWORD_ALLOWED           0x00000002
 295 #define WBC_MSV1_0_UPDATE_LOGON_STATISTICS              0x00000004
 296 #define WBC_MSV1_0_RETURN_USER_PARAMETERS               0x00000008
 297 #define WBC_MSV1_0_ALLOW_SERVER_TRUST_ACCOUNT           0x00000020
 298 #define WBC_MSV1_0_RETURN_PROFILE_PATH                  0x00000200
 299 #define WBC_MSV1_0_ALLOW_WORKSTATION_TRUST_ACCOUNT      0x00000800
 300
 301 /* wbcAuthUserParams->flags */
 302
 303 #define WBC_AUTH_PARAM_FLAGS_INTERACTIVE_LOGON          0x00000001
 304
 305 /**
 306  * @brief Auth User Information
 307  *
 308  * Some of the strings are maybe NULL
 309  **/
 310
 311 struct wbcAuthUserInfo {
 312         uint32_t user_flags;
 313
 314         char *account_name;
 315         char *user_principal;
 316         char *full_name;
 317         char *domain_name;
 318         char *dns_domain_name;
 319
 320         uint32_t acct_flags;
 321         uint8_t user_session_key[16];
 322         uint8_t lm_session_key[8];
 323
 324         uint16_t logon_count;
 325         uint16_t bad_password_count;
 326
 327         uint64_t logon_time;
 328         uint64_t logoff_time;
 329         uint64_t kickoff_time;
 330         uint64_t pass_last_set_time;
 331         uint64_t pass_can_change_time;
 332         uint64_t pass_must_change_time;
 333
 334         char *logon_server;
 335         char *logon_script;
 336         char *profile_path;
 337         char *home_directory;
 338         char *home_drive;
 339
 340         /*
 341          * the 1st one is the account sid
 342          * the 2nd one is the primary_group sid
 343          * followed by the rest of the groups
 344          */
 345         uint32_t num_sids;
 346         struct wbcSidWithAttr *sids;
 347 };
 348
 349 /**
 350  * @brief Logon User Information
 351  *
 352  * Some of the strings are maybe NULL
 353  **/
 354
 355 struct wbcLogonUserInfo {
 356         struct wbcAuthUserInfo *info;
 357         size_t num_blobs;
 358         struct wbcNamedBlob *blobs;
 359 };
 360
 361 /* wbcAuthUserInfo->user_flags */
 362
 363 #define WBC_AUTH_USER_INFO_GUEST                        0x00000001
 364 #define WBC_AUTH_USER_INFO_NOENCRYPTION                 0x00000002
 365 #define WBC_AUTH_USER_INFO_CACHED_ACCOUNT               0x00000004
 366 #define WBC_AUTH_USER_INFO_USED_LM_PASSWORD             0x00000008
 367 #define WBC_AUTH_USER_INFO_EXTRA_SIDS                   0x00000020
 368 #define WBC_AUTH_USER_INFO_SUBAUTH_SESSION_KEY          0x00000040
 369 #define WBC_AUTH_USER_INFO_SERVER_TRUST_ACCOUNT         0x00000080
 370 #define WBC_AUTH_USER_INFO_NTLMV2_ENABLED               0x00000100
 371 #define WBC_AUTH_USER_INFO_RESOURCE_GROUPS              0x00000200
 372 #define WBC_AUTH_USER_INFO_PROFILE_PATH_RETURNED        0x00000400
 373 #define WBC_AUTH_USER_INFO_GRACE_LOGON                  0x01000000
 374
 375 /* wbcAuthUserInfo->acct_flags */
 376
 377 #define WBC_ACB_DISABLED                        0x00000001 /* 1 User account disabled */
 378 #define WBC_ACB_HOMDIRREQ                       0x00000002 /* 1 Home directory required */
 379 #define WBC_ACB_PWNOTREQ                        0x00000004 /* 1 User password not required */
 380 #define WBC_ACB_TEMPDUP                         0x00000008 /* 1 Temporary duplicate account */
 381 #define WBC_ACB_NORMAL                          0x00000010 /* 1 Normal user account */
 382 #define WBC_ACB_MNS                             0x00000020 /* 1 MNS logon user account */
 383 #define WBC_ACB_DOMTRUST                        0x00000040 /* 1 Interdomain trust account */
 384 #define WBC_ACB_WSTRUST                         0x00000080 /* 1 Workstation trust account */
 385 #define WBC_ACB_SVRTRUST                        0x00000100 /* 1 Server trust account */
 386 #define WBC_ACB_PWNOEXP                         0x00000200 /* 1 User password does not expire */
 387 #define WBC_ACB_AUTOLOCK                        0x00000400 /* 1 Account auto locked */
 388 #define WBC_ACB_ENC_TXT_PWD_ALLOWED             0x00000800 /* 1 Encryped text password is allowed */
 389 #define WBC_ACB_SMARTCARD_REQUIRED              0x00001000 /* 1 Smart Card required */
 390 #define WBC_ACB_TRUSTED_FOR_DELEGATION          0x00002000 /* 1 Trusted for Delegation */
 391 #define WBC_ACB_NOT_DELEGATED                   0x00004000 /* 1 Not delegated */
 392 #define WBC_ACB_USE_DES_KEY_ONLY                0x00008000 /* 1 Use DES key only */
 393 #define WBC_ACB_DONT_REQUIRE_PREAUTH            0x00010000 /* 1 Preauth not required */
 394 #define WBC_ACB_PW_EXPIRED                      0x00020000 /* 1 Password Expired */
 395 #define WBC_ACB_NO_AUTH_DATA_REQD               0x00080000   /* 1 = No authorization data required */
 396
 397 struct wbcAuthErrorInfo {
 398         uint32_t nt_status;
 399         char *nt_string;
 400         int32_t pam_error;
 401         char *display_string;
 402 };
 403
 404 /**
 405  * @brief User Password Policy Information
 406  **/
 407
 408 /* wbcUserPasswordPolicyInfo->password_properties */
 409
 410 #define WBC_DOMAIN_PASSWORD_COMPLEX             0x00000001
 411 #define WBC_DOMAIN_PASSWORD_NO_ANON_CHANGE      0x00000002
 412 #define WBC_DOMAIN_PASSWORD_NO_CLEAR_CHANGE     0x00000004
 413 #define WBC_DOMAIN_PASSWORD_LOCKOUT_ADMINS      0x00000008
 414 #define WBC_DOMAIN_PASSWORD_STORE_CLEARTEXT     0x00000010
 415 #define WBC_DOMAIN_REFUSE_PASSWORD_CHANGE       0x00000020
 416
 417 struct wbcUserPasswordPolicyInfo {
 418         uint32_t min_length_password;
 419         uint32_t password_history;
 420         uint32_t password_properties;
 421         uint64_t expire;
 422         uint64_t min_passwordage;
 423 };
 424
 425 /**
 426  * @brief Change Password Reject Reason
 427  **/
 428
 429 enum wbcPasswordChangeRejectReason {
 430         WBC_PWD_CHANGE_REJECT_OTHER=0,
 431         WBC_PWD_CHANGE_REJECT_TOO_SHORT=1,
 432         WBC_PWD_CHANGE_REJECT_IN_HISTORY=2,
 433         WBC_PWD_CHANGE_REJECT_COMPLEXITY=5
 434 };
 435
 436 /**
 437  * @brief Logoff User Parameters
 438  **/
 439
 440 struct wbcLogoffUserParams {
 441         const char *username;
 442         size_t num_blobs;
 443         struct wbcNamedBlob *blobs;
 444 };
 445
 446 /** @brief Credential cache log-on parameters
 447  *
 448  */
 449
 450 struct wbcCredentialCacheParams {
 451         const char *account_name;
 452         const char *domain_name;
 453         enum wbcCredentialCacheLevel {
 454                 WBC_CREDENTIAL_CACHE_LEVEL_NTLMSSP = 1
 455         } level;
 456         size_t num_blobs;
 457         struct wbcNamedBlob *blobs;
 458 };
 459
 460
 461 /** @brief Info returned by credential cache auth
 462  *
 463  */
 464
 465 struct wbcCredentialCacheInfo {
 466         size_t num_blobs;
 467         struct wbcNamedBlob *blobs;
 468 };
 469
 470 /*
 471  * DomainControllerInfo struct
 472  */
 473 struct wbcDomainControllerInfo {
 474         char *dc_name;
 475 };
 476
 477 /*
 478  * DomainControllerInfoEx struct
 479  */
 480 struct wbcDomainControllerInfoEx {
 481         const char *dc_unc;
 482         const char *dc_address;
 483         uint16_t dc_address_type;
 484         struct wbcGuid *domain_guid;
 485         const char *domain_name;
 486         const char *forest_name;
 487         uint32_t dc_flags;
 488         const char *dc_site_name;
 489         const char *client_site_name;
 490 };
 491
 492 /**********************************************************
 493  * Memory Management
 494  **********************************************************/
 495
 496 /**
 497  * @brief Free library allocated memory
 498  *
 499  * @param * Pointer to free
 500  *
 501  * @return void
 502  **/
 503 void wbcFreeMemory(void*);
 504
 505
 506 /*
 507  * Utility functions for dealing with SIDs
 508  */
 509
 510 /**
 511  * @brief Get a string representation of the SID type
 512  *
 513  * @param type          type of the SID
 514  *
 515  * @return string representation of the SID type
 516  */
 517 const char* wbcSidTypeString(enum wbcSidType type);
 518
 519 /**
 520  * @brief Convert a binary SID to a character string
 521  *
 522  * @param sid           Binary Security Identifier
 523  * @param **sid_string  Resulting character string
 524  *
 525  * @return #wbcErr
 526  **/
 527 wbcErr wbcSidToString(const struct wbcDomainSid *sid,
 528                       char **sid_string);
 529
 530 /**
 531  * @brief Convert a character string to a binary SID
 532  *
 533  * @param *sid_string   Character string in the form of S-...
 534  * @param sid           Resulting binary SID
 535  *
 536  * @return #wbcErr
 537  **/
 538 wbcErr wbcStringToSid(const char *sid_string,
 539                       struct wbcDomainSid *sid);
 540
 541 /*
 542  * Utility functions for dealing with GUIDs
 543  */
 544
 545 /**
 546  * @brief Convert a binary GUID to a character string
 547  *
 548  * @param guid           Binary Guid
 549  * @param **guid_string  Resulting character string
 550  *
 551  * @return #wbcErr
 552  **/
 553 wbcErr wbcGuidToString(const struct wbcGuid *guid,
 554                        char **guid_string);
 555
 556 /**
 557  * @brief Convert a character string to a binary GUID
 558  *
 559  * @param *guid_string  Character string
 560  * @param guid          Resulting binary GUID
 561  *
 562  * @return #wbcErr
 563  **/
 564 wbcErr wbcStringToGuid(const char *guid_string,
 565                        struct wbcGuid *guid);
 566
 567 /**
 568  * @brief Ping winbindd to see if the daemon is running
 569  *
 570  * @return #wbcErr
 571  **/
 572 wbcErr wbcPing(void);
 573
 574 wbcErr wbcLibraryDetails(struct wbcLibraryDetails **details);
 575
 576 wbcErr wbcInterfaceDetails(struct wbcInterfaceDetails **details);
 577
 578 /**********************************************************
 579  * Name/SID conversion
 580  **********************************************************/
 581
 582 /**
 583  * @brief Convert a domain and name to SID
 584  *
 585  * @param dom_name    Domain name (possibly "")
 586  * @param name        User or group name
 587  * @param *sid        Pointer to the resolved domain SID
 588  * @param *name_type  Pointer to the SID type
 589  *
 590  * @return #wbcErr
 591  **/
 592 wbcErr wbcLookupName(const char *dom_name,
 593                      const char *name,
 594                      struct wbcDomainSid *sid,
 595                      enum wbcSidType *name_type);
 596
 597 /**
 598  * @brief Convert a SID to a domain and name
 599  *
 600  * @param *sid        Pointer to the domain SID to be resolved
 601  * @param domain     Resolved Domain name (possibly "")
 602  * @param name       Resolved User or group name
 603  * @param *name_type Pointer to the resolved SID type
 604  *
 605  * @return #wbcErr
 606  **/
 607 wbcErr wbcLookupSid(const struct wbcDomainSid *sid,
 608                     char **domain,
 609                     char **name,
 610                     enum wbcSidType *name_type);
 611
 612 /**
 613  * @brief Translate a collection of RIDs within a domain to names
 614  */
 615 wbcErr wbcLookupRids(struct wbcDomainSid *dom_sid,
 616                      int num_rids,
 617                      uint32_t *rids,
 618                      const char **domain_name,
 619                      const char ***names,
 620                      enum wbcSidType **types);
 621
 622 /*
 623  * @brief Get the groups a user belongs to
 624  **/
 625 wbcErr wbcLookupUserSids(const struct wbcDomainSid *user_sid,
 626                          bool domain_groups_only,
 627                          uint32_t *num_sids,
 628                          struct wbcDomainSid **sids);
 629
 630 /*
 631  * @brief Get alias membership for sids
 632  **/
 633 wbcErr wbcGetSidAliases(const struct wbcDomainSid *dom_sid,
 634                         struct wbcDomainSid *sids,
 635                         uint32_t num_sids,
 636                         uint32_t **alias_rids,
 637                         uint32_t *num_alias_rids);
 638
 639 /**
 640  * @brief Lists Users
 641  **/
 642 wbcErr wbcListUsers(const char *domain_name,
 643                     uint32_t *num_users,
 644                     const char ***users);
 645
 646 /**
 647  * @brief Lists Groups
 648  **/
 649 wbcErr wbcListGroups(const char *domain_name,
 650                      uint32_t *num_groups,
 651                      const char ***groups);
 652
 653 wbcErr wbcGetDisplayName(const struct wbcDomainSid *sid,
 654                          char **pdomain,
 655                          char **pfullname,
 656                          enum wbcSidType *pname_type);
 657
 658 /**********************************************************
 659  * SID/uid/gid Mappings
 660  **********************************************************/
 661
 662 /**
 663  * @brief Convert a Windows SID to a Unix uid, allocating an uid if needed
 664  *
 665  * @param *sid        Pointer to the domain SID to be resolved
 666  * @param *puid       Pointer to the resolved uid_t value
 667  *
 668  * @return #wbcErr
 669  *
 670  **/
 671 wbcErr wbcSidToUid(const struct wbcDomainSid *sid,
 672                    uid_t *puid);
 673
 674 /**
 675  * @brief Convert a Windows SID to a Unix uid if there already is a mapping
 676  *
 677  * @param *sid        Pointer to the domain SID to be resolved
 678  * @param *puid       Pointer to the resolved uid_t value
 679  *
 680  * @return #wbcErr
 681  *
 682  **/
 683 wbcErr wbcQuerySidToUid(const struct wbcDomainSid *sid,
 684                         uid_t *puid);
 685
 686 /**
 687  * @brief Convert a Unix uid to a Windows SID, allocating a SID if needed
 688  *
 689  * @param uid         Unix uid to be resolved
 690  * @param *sid        Pointer to the resolved domain SID
 691  *
 692  * @return #wbcErr
 693  *
 694  **/
 695 wbcErr wbcUidToSid(uid_t uid,
 696                    struct wbcDomainSid *sid);
 697
 698 /**
 699  * @brief Convert a Unix uid to a Windows SID if there already is a mapping
 700  *
 701  * @param uid         Unix uid to be resolved
 702  * @param *sid        Pointer to the resolved domain SID
 703  *
 704  * @return #wbcErr
 705  *
 706  **/
 707 wbcErr wbcQueryUidToSid(uid_t uid,
 708                         struct wbcDomainSid *sid);
 709
 710 /**
 711  * @brief Convert a Windows SID to a Unix gid, allocating a gid if needed
 712  *
 713  * @param *sid        Pointer to the domain SID to be resolved
 714  * @param *pgid       Pointer to the resolved gid_t value
 715  *
 716  * @return #wbcErr
 717  *
 718  **/
 719 wbcErr wbcSidToGid(const struct wbcDomainSid *sid,
 720                    gid_t *pgid);
 721
 722 /**
 723  * @brief Convert a Windows SID to a Unix gid if there already is a mapping
 724  *
 725  * @param *sid        Pointer to the domain SID to be resolved
 726  * @param *pgid       Pointer to the resolved gid_t value
 727  *
 728  * @return #wbcErr
 729  *
 730  **/
 731 wbcErr wbcQuerySidToGid(const struct wbcDomainSid *sid,
 732                         gid_t *pgid);
 733
 734 /**
 735  * @brief Convert a Unix gid to a Windows SID, allocating a SID if needed
 736  *
 737  * @param gid         Unix gid to be resolved
 738  * @param *sid        Pointer to the resolved domain SID
 739  *
 740  * @return #wbcErr
 741  *
 742  **/
 743 wbcErr wbcGidToSid(gid_t gid,
 744                    struct wbcDomainSid *sid);
 745
 746 /**
 747  * @brief Convert a Unix gid to a Windows SID if there already is a mapping
 748  *
 749  * @param gid         Unix gid to be resolved
 750  * @param *sid        Pointer to the resolved domain SID
 751  *
 752  * @return #wbcErr
 753  *
 754  **/
 755 wbcErr wbcQueryGidToSid(gid_t gid,
 756                         struct wbcDomainSid *sid);
 757
 758 /**
 759  * @brief Obtain a new uid from Winbind
 760  *
 761  * @param *puid      *pointer to the allocated uid
 762  *
 763  * @return #wbcErr
 764  **/
 765 wbcErr wbcAllocateUid(uid_t *puid);
 766
 767 /**
 768  * @brief Obtain a new gid from Winbind
 769  *
 770  * @param *pgid      Pointer to the allocated gid
 771  *
 772  * @return #wbcErr
 773  **/
 774 wbcErr wbcAllocateGid(gid_t *pgid);
 775
 776 /**
 777  * @brief Set an user id mapping
 778  *
 779  * @param uid       Uid of the desired mapping.
 780  * @param *sid      Pointer to the sid of the diresired mapping.
 781  *
 782  * @return #wbcErr
 783  **/
 784 wbcErr wbcSetUidMapping(uid_t uid, const struct wbcDomainSid *sid);
 785
 786 /**
 787  * @brief Set a group id mapping
 788  *
 789  * @param gid       Gid of the desired mapping.
 790  * @param *sid      Pointer to the sid of the diresired mapping.
 791  *
 792  * @return #wbcErr
 793  **/
 794 wbcErr wbcSetGidMapping(gid_t gid, const struct wbcDomainSid *sid);
 795
 796 /**
 797  * @brief Remove a user id mapping
 798  *
 799  * @param uid       Uid of the mapping to remove.
 800  * @param *sid      Pointer to the sid of the mapping to remove.
 801  *
 802  * @return #wbcErr
 803  **/
 804 wbcErr wbcRemoveUidMapping(uid_t uid, const struct wbcDomainSid *sid);
 805
 806 /**
 807  * @brief Remove a group id mapping
 808  *
 809  * @param gid       Gid of the mapping to remove.
 810  * @param *sid      Pointer to the sid of the mapping to remove.
 811  *
 812  * @return #wbcErr
 813  **/
 814 wbcErr wbcRemoveGidMapping(gid_t gid, const struct wbcDomainSid *sid);
 815
 816 /**
 817  * @brief Set the highwater mark for allocated uids.
 818  *
 819  * @param uid_hwm      The new uid highwater mark value
 820  *
 821  * @return #wbcErr
 822  **/
 823 wbcErr wbcSetUidHwm(uid_t uid_hwm);
 824
 825 /**
 826  * @brief Set the highwater mark for allocated gids.
 827  *
 828  * @param gid_hwm      The new gid highwater mark value
 829  *
 830  * @return #wbcErr
 831  **/
 832 wbcErr wbcSetGidHwm(gid_t gid_hwm);
 833
 834 /**********************************************************
 835  * NSS Lookup User/Group details
 836  **********************************************************/
 837
 838 /**
 839  * @brief Fill in a struct passwd* for a domain user based
 840  *   on username
 841  *
 842  * @param *name     Username to lookup
 843  * @param **pwd     Pointer to resulting struct passwd* from the query.
 844  *
 845  * @return #wbcErr
 846  **/
 847 wbcErr wbcGetpwnam(const char *name, struct passwd **pwd);
 848
 849 /**
 850  * @brief Fill in a struct passwd* for a domain user based
 851  *   on uid
 852  *
 853  * @param uid       Uid to lookup
 854  * @param **pwd     Pointer to resulting struct passwd* from the query.
 855  *
 856  * @return #wbcErr
 857  **/
 858 wbcErr wbcGetpwuid(uid_t uid, struct passwd **pwd);
 859
 860 /**
 861  * @brief Fill in a struct passwd* for a domain user based
 862  *   on sid
 863  *
 864  * @param sid       Sid to lookup
 865  * @param **pwd     Pointer to resulting struct passwd* from the query.
 866  *
 867  * @return #wbcErr
 868  **/
 869 wbcErr wbcGetpwsid(struct wbcDomainSid * sid, struct passwd **pwd);
 870
 871 /**
 872  * @brief Fill in a struct passwd* for a domain user based
 873  *   on username
 874  *
 875  * @param *name     Username to lookup
 876  * @param **grp     Pointer to resulting struct group* from the query.
 877  *
 878  * @return #wbcErr
 879  **/
 880 wbcErr wbcGetgrnam(const char *name, struct group **grp);
 881
 882 /**
 883  * @brief Fill in a struct passwd* for a domain user based
 884  *   on uid
 885  *
 886  * @param gid       Uid to lookup
 887  * @param **grp     Pointer to resulting struct group* from the query.
 888  *
 889  * @return #wbcErr
 890  **/
 891 wbcErr wbcGetgrgid(gid_t gid, struct group **grp);
 892
 893 /**
 894  * @brief Reset the passwd iterator
 895  *
 896  * @return #wbcErr
 897  **/
 898 wbcErr wbcSetpwent(void);
 899
 900 /**
 901  * @brief Close the passwd iterator
 902  *
 903  * @return #wbcErr
 904  **/
 905 wbcErr wbcEndpwent(void);
 906
 907 /**
 908  * @brief Return the next struct passwd* entry from the pwent iterator
 909  *
 910  * @param **pwd       Pointer to resulting struct passwd* from the query.
 911  *
 912  * @return #wbcErr
 913  **/
 914 wbcErr wbcGetpwent(struct passwd **pwd);
 915
 916 /**
 917  * @brief Reset the group iterator
 918  *
 919  * @return #wbcErr
 920  **/
 921 wbcErr wbcSetgrent(void);
 922
 923 /**
 924  * @brief Close the group iterator
 925  *
 926  * @return #wbcErr
 927  **/
 928 wbcErr wbcEndgrent(void);
 929
 930 /**
 931  * @brief Return the next struct group* entry from the pwent iterator
 932  *
 933  * @param **grp       Pointer to resulting struct group* from the query.
 934  *
 935  * @return #wbcErr
 936  **/
 937 wbcErr wbcGetgrent(struct group **grp);
 938
 939 /**
 940  * @brief Return the next struct group* entry from the pwent iterator
 941  *
 942  * This is similar to #wbcGetgrent, just that the member list is empty
 943  *
 944  * @param **grp       Pointer to resulting struct group* from the query.
 945  *
 946  * @return #wbcErr
 947  **/
 948 wbcErr wbcGetgrlist(struct group **grp);
 949
 950 /**
 951  * @brief Return the unix group array belonging to the given user
 952  *
 953  * @param *account       The given user name
 954  * @param *num_groups    Number of elements returned in the groups array
 955  * @param **_groups      Pointer to resulting gid_t array.
 956  *
 957  * @return #wbcErr
 958  **/
 959 wbcErr wbcGetGroups(const char *account,
 960                     uint32_t *num_groups,
 961                     gid_t **_groups);
 962
 963
 964 /**********************************************************
 965  * Lookup Domain information
 966  **********************************************************/
 967
 968 /**
 969  * @brief Lookup the current status of a trusted domain
 970  *
 971  * @param domain      Domain to query
 972  * @param *info       Pointer to returned domain_info struct
 973  *
 974  * @return #wbcErr
 975  **/
 976 wbcErr wbcDomainInfo(const char *domain,
 977                      struct wbcDomainInfo **info);
 978
 979 /**
 980  * @brief Enumerate the domain trusts known by Winbind
 981  *
 982  * @param **domains     Pointer to the allocated domain list array
 983  * @param *num_domains  Pointer to number of domains returned
 984  *
 985  * @return #wbcErr
 986  **/
 987 wbcErr wbcListTrusts(struct wbcDomainInfo **domains,
 988                      size_t *num_domains);
 989
 990 /* Flags for wbcLookupDomainController */
 991
 992 #define WBC_LOOKUP_DC_FORCE_REDISCOVERY        0x00000001
 993 #define WBC_LOOKUP_DC_DS_REQUIRED              0x00000010
 994 #define WBC_LOOKUP_DC_DS_PREFERRED             0x00000020
 995 #define WBC_LOOKUP_DC_GC_SERVER_REQUIRED       0x00000040
 996 #define WBC_LOOKUP_DC_PDC_REQUIRED             0x00000080
 997 #define WBC_LOOKUP_DC_BACKGROUND_ONLY          0x00000100
 998 #define WBC_LOOKUP_DC_IP_REQUIRED              0x00000200
 999 #define WBC_LOOKUP_DC_KDC_REQUIRED             0x00000400
1000 #define WBC_LOOKUP_DC_TIMESERV_REQUIRED        0x00000800
1001 #define WBC_LOOKUP_DC_WRITABLE_REQUIRED        0x00001000
1002 #define WBC_LOOKUP_DC_GOOD_TIMESERV_PREFERRED  0x00002000
1003 #define WBC_LOOKUP_DC_AVOID_SELF               0x00004000
1004 #define WBC_LOOKUP_DC_ONLY_LDAP_NEEDED         0x00008000
1005 #define WBC_LOOKUP_DC_IS_FLAT_NAME             0x00010000
1006 #define WBC_LOOKUP_DC_IS_DNS_NAME              0x00020000
1007 #define WBC_LOOKUP_DC_TRY_NEXTCLOSEST_SITE     0x00040000
1008 #define WBC_LOOKUP_DC_DS_6_REQUIRED            0x00080000
1009 #define WBC_LOOKUP_DC_RETURN_DNS_NAME          0x40000000
1010 #define WBC_LOOKUP_DC_RETURN_FLAT_NAME         0x80000000
1011
1012 /**
1013  * @brief Enumerate the domain trusts known by Winbind
1014  *
1015  * @param domain        Name of the domain to query for a DC
1016  * @param flags         Bit flags used to control the domain location query
1017  * @param *dc_info      Pointer to the returned domain controller information
1018  *
1019  * @return #wbcErr
1020  **/
1021 wbcErr wbcLookupDomainController(const char *domain,
1022                                  uint32_t flags,
1023                                  struct wbcDomainControllerInfo **dc_info);
1024
1025 /**
1026  * @brief Get extended domain controller information
1027  *
1028  * @param domain        Name of the domain to query for a DC
1029  * @param guid          Guid of the domain to query for a DC
1030  * @param site          Site of the domain to query for a DC
1031  * @param flags         Bit flags used to control the domain location query
1032  * @param *dc_info      Pointer to the returned extended domain controller information
1033  *
1034  * @return #wbcErr
1035  **/
1036 wbcErr wbcLookupDomainControllerEx(const char *domain,
1037                                    struct wbcGuid *guid,
1038                                    const char *site,
1039                                    uint32_t flags,
1040                                    struct wbcDomainControllerInfoEx **dc_info);
1041
1042 /**********************************************************
1043  * Athenticate functions
1044  **********************************************************/
1045
1046 /**
1047  * @brief Authenticate a username/password pair
1048  *
1049  * @param username     Name of user to authenticate
1050  * @param password     Clear text password os user
1051  *
1052  * @return #wbcErr
1053  **/
1054 wbcErr wbcAuthenticateUser(const char *username,
1055                            const char *password);
1056
1057 /**
1058  * @brief Authenticate with more detailed information
1059  *
1060  * @param params       Input parameters, WBC_AUTH_USER_LEVEL_HASH
1061  *                     is not supported yet
1062  * @param info         Output details on WBC_ERR_SUCCESS
1063  * @param error        Output details on WBC_ERR_AUTH_ERROR
1064  *
1065  * @return #wbcErr
1066  **/
1067 wbcErr wbcAuthenticateUserEx(const struct wbcAuthUserParams *params,
1068                              struct wbcAuthUserInfo **info,
1069                              struct wbcAuthErrorInfo **error);
1070
1071 /**
1072  * @brief Logon a User
1073  *
1074  * @param[in]  params      Pointer to a wbcLogonUserParams structure
1075  * @param[out] info        Pointer to a pointer to a wbcLogonUserInfo structure
1076  * @param[out] error       Pointer to a pointer to a wbcAuthErrorInfo structure
1077  * @param[out] policy      Pointer to a pointer to a wbcUserPasswordPolicyInfo structure
1078  *
1079  * @return #wbcErr
1080  **/
1081 wbcErr wbcLogonUser(const struct wbcLogonUserParams *params,
1082                     struct wbcLogonUserInfo **info,
1083                     struct wbcAuthErrorInfo **error,
1084                     struct wbcUserPasswordPolicyInfo **policy);
1085
1086 /**
1087  * @brief Trigger a logoff notification to Winbind for a specific user
1088  *
1089  * @param username    Name of user to remove from Winbind's list of
1090  *                    logged on users.
1091  * @param uid         Uid assigned to the username
1092  * @param ccfilename  Absolute path to the Krb5 credentials cache to
1093  *                    be removed
1094  *
1095  * @return #wbcErr
1096  **/
1097 wbcErr wbcLogoffUser(const char *username,
1098                      uid_t uid,
1099                      const char *ccfilename);
1100
1101 /**
1102  * @brief Trigger an extended logoff notification to Winbind for a specific user
1103  *
1104  * @param params      A wbcLogoffUserParams structure
1105  * @param error       User output details on error
1106  *
1107  * @return #wbcErr
1108  **/
1109 wbcErr wbcLogoffUserEx(const struct wbcLogoffUserParams *params,
1110                        struct wbcAuthErrorInfo **error);
1111
1112 /**
1113  * @brief Change a password for a user
1114  *
1115  * @param username      Name of user to authenticate
1116  * @param old_password  Old clear text password of user
1117  * @param new_password  New clear text password of user
1118  *
1119  * @return #wbcErr
1120  **/
1121 wbcErr wbcChangeUserPassword(const char *username,
1122                              const char *old_password,
1123                              const char *new_password);
1124
1125 /**
1126  * @brief Change a password for a user with more detailed information upon
1127  *   failure
1128  *
1129  * @param params                Input parameters
1130  * @param error                 User output details on WBC_ERR_PWD_CHANGE_FAILED
1131  * @param reject_reason         New password reject reason on WBC_ERR_PWD_CHANGE_FAILED
1132  * @param policy                Password policy output details on WBC_ERR_PWD_CHANGE_FAILED
1133  *
1134  * @return #wbcErr
1135  **/
1136 wbcErr wbcChangeUserPasswordEx(const struct wbcChangePasswordParams *params,
1137                                struct wbcAuthErrorInfo **error,
1138                                enum wbcPasswordChangeRejectReason *reject_reason,
1139                                struct wbcUserPasswordPolicyInfo **policy);
1140
1141 /**
1142  * @brief Authenticate a user with cached credentials
1143  *
1144  * @param *params    Pointer to a wbcCredentialCacheParams structure
1145  * @param **info     Pointer to a pointer to a wbcCredentialCacheInfo structure
1146  * @param **error    Pointer to a pointer to a wbcAuthErrorInfo structure
1147  *
1148  * @return #wbcErr
1149  **/
1150 wbcErr wbcCredentialCache(struct wbcCredentialCacheParams *params,
1151                           struct wbcCredentialCacheInfo **info,
1152                           struct wbcAuthErrorInfo **error);
1153
1154 /**********************************************************
1155  * Resolve functions
1156  **********************************************************/
1157
1158 /**
1159  * @brief Resolve a NetbiosName via WINS
1160  *
1161  * @param name         Name to resolve
1162  * @param *ip          Pointer to the ip address string
1163  *
1164  * @return #wbcErr
1165  **/
1166 wbcErr wbcResolveWinsByName(const char *name, char **ip);
1167
1168 /**
1169  * @brief Resolve an IP address via WINS into a NetbiosName
1170  *
1171  * @param ip          The ip address string
1172  * @param *name       Pointer to the name
1173  *
1174  * @return #wbcErr
1175  *
1176  **/
1177 wbcErr wbcResolveWinsByIP(const char *ip, char **name);
1178
1179 /**********************************************************
1180  * Trusted domain functions
1181  **********************************************************/
1182
1183 /**
1184  * @brief Trigger a verification of the trust credentials of a specific domain
1185  *
1186  * @param *domain      The name of the domain.
1187  * @param error        Output details on WBC_ERR_AUTH_ERROR
1188  *
1189  * @return #wbcErr
1190  **/
1191 wbcErr wbcCheckTrustCredentials(const char *domain,
1192                                 struct wbcAuthErrorInfo **error);
1193
1194 /**********************************************************
1195  * Helper functions
1196  **********************************************************/
1197
1198 /**
1199  * @brief Initialize a named blob and add to list of blobs
1200  *
1201  * @param[in,out] num_blobs     Pointer to the number of blobs
1202  * @param[in,out] blobs         Pointer to an array of blobs
1203  * @param[in]     name          Name of the new named blob
1204  * @param[in]     flags         Flags of the new named blob
1205  * @param[in]     data          Blob data of new blob
1206  * @param[in]     length        Blob data length of new blob
1207  *
1208  * @return #wbcErr
1209  **/
1210 wbcErr wbcAddNamedBlob(size_t *num_blobs,
1211                        struct wbcNamedBlob **blobs,
1212                        const char *name,
1213                        uint32_t flags,
1214                        uint8_t *data,
1215                        size_t length);
1216
1217 #endif      /* _WBCLIENT_H */