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_NO_ERROR=0,
 431         WBC_PWD_CHANGE_PASSWORD_TOO_SHORT=1,
 432         WBC_PWD_CHANGE_PWD_IN_HISTORY=2,
 433         WBC_PWD_CHANGE_USERNAME_IN_PASSWORD=3,
 434         WBC_PWD_CHANGE_FULLNAME_IN_PASSWORD=4,
 435         WBC_PWD_CHANGE_NOT_COMPLEX=5,
 436         WBC_PWD_CHANGE_MACHINE_NOT_DEFAULT=6,
 437         WBC_PWD_CHANGE_FAILED_BY_FILTER=7,
 438         WBC_PWD_CHANGE_PASSWORD_TOO_LONG=8
 439 };
 440
 441 /**
 442  * @brief Logoff User Parameters
 443  **/
 444
 445 struct wbcLogoffUserParams {
 446         const char *username;
 447         size_t num_blobs;
 448         struct wbcNamedBlob *blobs;
 449 };
 450
 451 /** @brief Credential cache log-on parameters
 452  *
 453  */
 454
 455 struct wbcCredentialCacheParams {
 456         const char *account_name;
 457         const char *domain_name;
 458         enum wbcCredentialCacheLevel {
 459                 WBC_CREDENTIAL_CACHE_LEVEL_NTLMSSP = 1
 460         } level;
 461         size_t num_blobs;
 462         struct wbcNamedBlob *blobs;
 463 };
 464
 465
 466 /** @brief Info returned by credential cache auth
 467  *
 468  */
 469
 470 struct wbcCredentialCacheInfo {
 471         size_t num_blobs;
 472         struct wbcNamedBlob *blobs;
 473 };
 474
 475 /*
 476  * DomainControllerInfo struct
 477  */
 478 struct wbcDomainControllerInfo {
 479         char *dc_name;
 480 };
 481
 482 /*
 483  * DomainControllerInfoEx struct
 484  */
 485 struct wbcDomainControllerInfoEx {
 486         const char *dc_unc;
 487         const char *dc_address;
 488         uint16_t dc_address_type;
 489         struct wbcGuid *domain_guid;
 490         const char *domain_name;
 491         const char *forest_name;
 492         uint32_t dc_flags;
 493         const char *dc_site_name;
 494         const char *client_site_name;
 495 };
 496
 497 /**********************************************************
 498  * Memory Management
 499  **********************************************************/
 500
 501 /**
 502  * @brief Free library allocated memory
 503  *
 504  * @param * Pointer to free
 505  *
 506  * @return void
 507  **/
 508 void wbcFreeMemory(void*);
 509
 510
 511 /*
 512  * Utility functions for dealing with SIDs
 513  */
 514
 515 /**
 516  * @brief Get a string representation of the SID type
 517  *
 518  * @param type          type of the SID
 519  *
 520  * @return string representation of the SID type
 521  */
 522 const char* wbcSidTypeString(enum wbcSidType type);
 523
 524 /**
 525  * @brief Convert a binary SID to a character string
 526  *
 527  * @param sid           Binary Security Identifier
 528  * @param **sid_string  Resulting character string
 529  *
 530  * @return #wbcErr
 531  **/
 532 wbcErr wbcSidToString(const struct wbcDomainSid *sid,
 533                       char **sid_string);
 534
 535 /**
 536  * @brief Convert a character string to a binary SID
 537  *
 538  * @param *sid_string   Character string in the form of S-...
 539  * @param sid           Resulting binary SID
 540  *
 541  * @return #wbcErr
 542  **/
 543 wbcErr wbcStringToSid(const char *sid_string,
 544                       struct wbcDomainSid *sid);
 545
 546 /*
 547  * Utility functions for dealing with GUIDs
 548  */
 549
 550 /**
 551  * @brief Convert a binary GUID to a character string
 552  *
 553  * @param guid           Binary Guid
 554  * @param **guid_string  Resulting character string
 555  *
 556  * @return #wbcErr
 557  **/
 558 wbcErr wbcGuidToString(const struct wbcGuid *guid,
 559                        char **guid_string);
 560
 561 /**
 562  * @brief Convert a character string to a binary GUID
 563  *
 564  * @param *guid_string  Character string
 565  * @param guid          Resulting binary GUID
 566  *
 567  * @return #wbcErr
 568  **/
 569 wbcErr wbcStringToGuid(const char *guid_string,
 570                        struct wbcGuid *guid);
 571
 572 /**
 573  * @brief Ping winbindd to see if the daemon is running
 574  *
 575  * @return #wbcErr
 576  **/
 577 wbcErr wbcPing(void);
 578
 579 wbcErr wbcLibraryDetails(struct wbcLibraryDetails **details);
 580
 581 wbcErr wbcInterfaceDetails(struct wbcInterfaceDetails **details);
 582
 583 /**********************************************************
 584  * Name/SID conversion
 585  **********************************************************/
 586
 587 /**
 588  * @brief Convert a domain and name to SID
 589  *
 590  * @param dom_name    Domain name (possibly "")
 591  * @param name        User or group name
 592  * @param *sid        Pointer to the resolved domain SID
 593  * @param *name_type  Pointer to the SID type
 594  *
 595  * @return #wbcErr
 596  **/
 597 wbcErr wbcLookupName(const char *dom_name,
 598                      const char *name,
 599                      struct wbcDomainSid *sid,
 600                      enum wbcSidType *name_type);
 601
 602 /**
 603  * @brief Convert a SID to a domain and name
 604  *
 605  * @param *sid        Pointer to the domain SID to be resolved
 606  * @param domain     Resolved Domain name (possibly "")
 607  * @param name       Resolved User or group name
 608  * @param *name_type Pointer to the resolved SID type
 609  *
 610  * @return #wbcErr
 611  **/
 612 wbcErr wbcLookupSid(const struct wbcDomainSid *sid,
 613                     char **domain,
 614                     char **name,
 615                     enum wbcSidType *name_type);
 616
 617 /**
 618  * @brief Translate a collection of RIDs within a domain to names
 619  */
 620 wbcErr wbcLookupRids(struct wbcDomainSid *dom_sid,
 621                      int num_rids,
 622                      uint32_t *rids,
 623                      const char **domain_name,
 624                      const char ***names,
 625                      enum wbcSidType **types);
 626
 627 /*
 628  * @brief Get the groups a user belongs to
 629  **/
 630 wbcErr wbcLookupUserSids(const struct wbcDomainSid *user_sid,
 631                          bool domain_groups_only,
 632                          uint32_t *num_sids,
 633                          struct wbcDomainSid **sids);
 634
 635 /*
 636  * @brief Get alias membership for sids
 637  **/
 638 wbcErr wbcGetSidAliases(const struct wbcDomainSid *dom_sid,
 639                         struct wbcDomainSid *sids,
 640                         uint32_t num_sids,
 641                         uint32_t **alias_rids,
 642                         uint32_t *num_alias_rids);
 643
 644 /**
 645  * @brief Lists Users
 646  **/
 647 wbcErr wbcListUsers(const char *domain_name,
 648                     uint32_t *num_users,
 649                     const char ***users);
 650
 651 /**
 652  * @brief Lists Groups
 653  **/
 654 wbcErr wbcListGroups(const char *domain_name,
 655                      uint32_t *num_groups,
 656                      const char ***groups);
 657
 658 wbcErr wbcGetDisplayName(const struct wbcDomainSid *sid,
 659                          char **pdomain,
 660                          char **pfullname,
 661                          enum wbcSidType *pname_type);
 662
 663 /**********************************************************
 664  * SID/uid/gid Mappings
 665  **********************************************************/
 666
 667 /**
 668  * @brief Convert a Windows SID to a Unix uid, allocating an uid if needed
 669  *
 670  * @param *sid        Pointer to the domain SID to be resolved
 671  * @param *puid       Pointer to the resolved uid_t value
 672  *
 673  * @return #wbcErr
 674  *
 675  **/
 676 wbcErr wbcSidToUid(const struct wbcDomainSid *sid,
 677                    uid_t *puid);
 678
 679 /**
 680  * @brief Convert a Windows SID to a Unix uid if there already is a mapping
 681  *
 682  * @param *sid        Pointer to the domain SID to be resolved
 683  * @param *puid       Pointer to the resolved uid_t value
 684  *
 685  * @return #wbcErr
 686  *
 687  **/
 688 wbcErr wbcQuerySidToUid(const struct wbcDomainSid *sid,
 689                         uid_t *puid);
 690
 691 /**
 692  * @brief Convert a Unix uid to a Windows SID, allocating a SID if needed
 693  *
 694  * @param uid         Unix uid to be resolved
 695  * @param *sid        Pointer to the resolved domain SID
 696  *
 697  * @return #wbcErr
 698  *
 699  **/
 700 wbcErr wbcUidToSid(uid_t uid,
 701                    struct wbcDomainSid *sid);
 702
 703 /**
 704  * @brief Convert a Unix uid to a Windows SID if there already is a mapping
 705  *
 706  * @param uid         Unix uid to be resolved
 707  * @param *sid        Pointer to the resolved domain SID
 708  *
 709  * @return #wbcErr
 710  *
 711  **/
 712 wbcErr wbcQueryUidToSid(uid_t uid,
 713                         struct wbcDomainSid *sid);
 714
 715 /**
 716  * @brief Convert a Windows SID to a Unix gid, allocating a gid if needed
 717  *
 718  * @param *sid        Pointer to the domain SID to be resolved
 719  * @param *pgid       Pointer to the resolved gid_t value
 720  *
 721  * @return #wbcErr
 722  *
 723  **/
 724 wbcErr wbcSidToGid(const struct wbcDomainSid *sid,
 725                    gid_t *pgid);
 726
 727 /**
 728  * @brief Convert a Windows SID to a Unix gid if there already is a mapping
 729  *
 730  * @param *sid        Pointer to the domain SID to be resolved
 731  * @param *pgid       Pointer to the resolved gid_t value
 732  *
 733  * @return #wbcErr
 734  *
 735  **/
 736 wbcErr wbcQuerySidToGid(const struct wbcDomainSid *sid,
 737                         gid_t *pgid);
 738
 739 /**
 740  * @brief Convert a Unix gid to a Windows SID, allocating a SID if needed
 741  *
 742  * @param gid         Unix gid to be resolved
 743  * @param *sid        Pointer to the resolved domain SID
 744  *
 745  * @return #wbcErr
 746  *
 747  **/
 748 wbcErr wbcGidToSid(gid_t gid,
 749                    struct wbcDomainSid *sid);
 750
 751 /**
 752  * @brief Convert a Unix gid to a Windows SID if there already is a mapping
 753  *
 754  * @param gid         Unix gid to be resolved
 755  * @param *sid        Pointer to the resolved domain SID
 756  *
 757  * @return #wbcErr
 758  *
 759  **/
 760 wbcErr wbcQueryGidToSid(gid_t gid,
 761                         struct wbcDomainSid *sid);
 762
 763 /**
 764  * @brief Obtain a new uid from Winbind
 765  *
 766  * @param *puid      *pointer to the allocated uid
 767  *
 768  * @return #wbcErr
 769  **/
 770 wbcErr wbcAllocateUid(uid_t *puid);
 771
 772 /**
 773  * @brief Obtain a new gid from Winbind
 774  *
 775  * @param *pgid      Pointer to the allocated gid
 776  *
 777  * @return #wbcErr
 778  **/
 779 wbcErr wbcAllocateGid(gid_t *pgid);
 780
 781 /**
 782  * @brief Set an user id mapping
 783  *
 784  * @param uid       Uid of the desired mapping.
 785  * @param *sid      Pointer to the sid of the diresired mapping.
 786  *
 787  * @return #wbcErr
 788  **/
 789 wbcErr wbcSetUidMapping(uid_t uid, const struct wbcDomainSid *sid);
 790
 791 /**
 792  * @brief Set a group id mapping
 793  *
 794  * @param gid       Gid of the desired mapping.
 795  * @param *sid      Pointer to the sid of the diresired mapping.
 796  *
 797  * @return #wbcErr
 798  **/
 799 wbcErr wbcSetGidMapping(gid_t gid, const struct wbcDomainSid *sid);
 800
 801 /**
 802  * @brief Remove a user id mapping
 803  *
 804  * @param uid       Uid of the mapping to remove.
 805  * @param *sid      Pointer to the sid of the mapping to remove.
 806  *
 807  * @return #wbcErr
 808  **/
 809 wbcErr wbcRemoveUidMapping(uid_t uid, const struct wbcDomainSid *sid);
 810
 811 /**
 812  * @brief Remove a group id mapping
 813  *
 814  * @param gid       Gid of the mapping to remove.
 815  * @param *sid      Pointer to the sid of the mapping to remove.
 816  *
 817  * @return #wbcErr
 818  **/
 819 wbcErr wbcRemoveGidMapping(gid_t gid, const struct wbcDomainSid *sid);
 820
 821 /**
 822  * @brief Set the highwater mark for allocated uids.
 823  *
 824  * @param uid_hwm      The new uid highwater mark value
 825  *
 826  * @return #wbcErr
 827  **/
 828 wbcErr wbcSetUidHwm(uid_t uid_hwm);
 829
 830 /**
 831  * @brief Set the highwater mark for allocated gids.
 832  *
 833  * @param gid_hwm      The new gid highwater mark value
 834  *
 835  * @return #wbcErr
 836  **/
 837 wbcErr wbcSetGidHwm(gid_t gid_hwm);
 838
 839 /**********************************************************
 840  * NSS Lookup User/Group details
 841  **********************************************************/
 842
 843 /**
 844  * @brief Fill in a struct passwd* for a domain user based
 845  *   on username
 846  *
 847  * @param *name     Username to lookup
 848  * @param **pwd     Pointer to resulting struct passwd* from the query.
 849  *
 850  * @return #wbcErr
 851  **/
 852 wbcErr wbcGetpwnam(const char *name, struct passwd **pwd);
 853
 854 /**
 855  * @brief Fill in a struct passwd* for a domain user based
 856  *   on uid
 857  *
 858  * @param uid       Uid to lookup
 859  * @param **pwd     Pointer to resulting struct passwd* from the query.
 860  *
 861  * @return #wbcErr
 862  **/
 863 wbcErr wbcGetpwuid(uid_t uid, struct passwd **pwd);
 864
 865 /**
 866  * @brief Fill in a struct passwd* for a domain user based
 867  *   on sid
 868  *
 869  * @param sid       Sid to lookup
 870  * @param **pwd     Pointer to resulting struct passwd* from the query.
 871  *
 872  * @return #wbcErr
 873  **/
 874 wbcErr wbcGetpwsid(struct wbcDomainSid * sid, struct passwd **pwd);
 875
 876 /**
 877  * @brief Fill in a struct passwd* for a domain user based
 878  *   on username
 879  *
 880  * @param *name     Username to lookup
 881  * @param **grp     Pointer to resulting struct group* from the query.
 882  *
 883  * @return #wbcErr
 884  **/
 885 wbcErr wbcGetgrnam(const char *name, struct group **grp);
 886
 887 /**
 888  * @brief Fill in a struct passwd* for a domain user based
 889  *   on uid
 890  *
 891  * @param gid       Uid to lookup
 892  * @param **grp     Pointer to resulting struct group* from the query.
 893  *
 894  * @return #wbcErr
 895  **/
 896 wbcErr wbcGetgrgid(gid_t gid, struct group **grp);
 897
 898 /**
 899  * @brief Reset the passwd iterator
 900  *
 901  * @return #wbcErr
 902  **/
 903 wbcErr wbcSetpwent(void);
 904
 905 /**
 906  * @brief Close the passwd iterator
 907  *
 908  * @return #wbcErr
 909  **/
 910 wbcErr wbcEndpwent(void);
 911
 912 /**
 913  * @brief Return the next struct passwd* entry from the pwent iterator
 914  *
 915  * @param **pwd       Pointer to resulting struct passwd* from the query.
 916  *
 917  * @return #wbcErr
 918  **/
 919 wbcErr wbcGetpwent(struct passwd **pwd);
 920
 921 /**
 922  * @brief Reset the group iterator
 923  *
 924  * @return #wbcErr
 925  **/
 926 wbcErr wbcSetgrent(void);
 927
 928 /**
 929  * @brief Close the group iterator
 930  *
 931  * @return #wbcErr
 932  **/
 933 wbcErr wbcEndgrent(void);
 934
 935 /**
 936  * @brief Return the next struct group* entry from the pwent iterator
 937  *
 938  * @param **grp       Pointer to resulting struct group* from the query.
 939  *
 940  * @return #wbcErr
 941  **/
 942 wbcErr wbcGetgrent(struct group **grp);
 943
 944 /**
 945  * @brief Return the next struct group* entry from the pwent iterator
 946  *
 947  * This is similar to #wbcGetgrent, just that the member list is empty
 948  *
 949  * @param **grp       Pointer to resulting struct group* from the query.
 950  *
 951  * @return #wbcErr
 952  **/
 953 wbcErr wbcGetgrlist(struct group **grp);
 954
 955 /**
 956  * @brief Return the unix group array belonging to the given user
 957  *
 958  * @param *account       The given user name
 959  * @param *num_groups    Number of elements returned in the groups array
 960  * @param **_groups      Pointer to resulting gid_t array.
 961  *
 962  * @return #wbcErr
 963  **/
 964 wbcErr wbcGetGroups(const char *account,
 965                     uint32_t *num_groups,
 966                     gid_t **_groups);
 967
 968
 969 /**********************************************************
 970  * Lookup Domain information
 971  **********************************************************/
 972
 973 /**
 974  * @brief Lookup the current status of a trusted domain
 975  *
 976  * @param domain      Domain to query
 977  * @param *info       Pointer to returned domain_info struct
 978  *
 979  * @return #wbcErr
 980  **/
 981 wbcErr wbcDomainInfo(const char *domain,
 982                      struct wbcDomainInfo **info);
 983
 984 /**
 985  * @brief Enumerate the domain trusts known by Winbind
 986  *
 987  * @param **domains     Pointer to the allocated domain list array
 988  * @param *num_domains  Pointer to number of domains returned
 989  *
 990  * @return #wbcErr
 991  **/
 992 wbcErr wbcListTrusts(struct wbcDomainInfo **domains,
 993                      size_t *num_domains);
 994
 995 /* Flags for wbcLookupDomainController */
 996
 997 #define WBC_LOOKUP_DC_FORCE_REDISCOVERY        0x00000001
 998 #define WBC_LOOKUP_DC_DS_REQUIRED              0x00000010
 999 #define WBC_LOOKUP_DC_DS_PREFERRED             0x00000020
1000 #define WBC_LOOKUP_DC_GC_SERVER_REQUIRED       0x00000040
1001 #define WBC_LOOKUP_DC_PDC_REQUIRED             0x00000080
1002 #define WBC_LOOKUP_DC_BACKGROUND_ONLY          0x00000100
1003 #define WBC_LOOKUP_DC_IP_REQUIRED              0x00000200
1004 #define WBC_LOOKUP_DC_KDC_REQUIRED             0x00000400
1005 #define WBC_LOOKUP_DC_TIMESERV_REQUIRED        0x00000800
1006 #define WBC_LOOKUP_DC_WRITABLE_REQUIRED        0x00001000
1007 #define WBC_LOOKUP_DC_GOOD_TIMESERV_PREFERRED  0x00002000
1008 #define WBC_LOOKUP_DC_AVOID_SELF               0x00004000
1009 #define WBC_LOOKUP_DC_ONLY_LDAP_NEEDED         0x00008000
1010 #define WBC_LOOKUP_DC_IS_FLAT_NAME             0x00010000
1011 #define WBC_LOOKUP_DC_IS_DNS_NAME              0x00020000
1012 #define WBC_LOOKUP_DC_TRY_NEXTCLOSEST_SITE     0x00040000
1013 #define WBC_LOOKUP_DC_DS_6_REQUIRED            0x00080000
1014 #define WBC_LOOKUP_DC_RETURN_DNS_NAME          0x40000000
1015 #define WBC_LOOKUP_DC_RETURN_FLAT_NAME         0x80000000
1016
1017 /**
1018  * @brief Enumerate the domain trusts known by Winbind
1019  *
1020  * @param domain        Name of the domain to query for a DC
1021  * @param flags         Bit flags used to control the domain location query
1022  * @param *dc_info      Pointer to the returned domain controller information
1023  *
1024  * @return #wbcErr
1025  **/
1026 wbcErr wbcLookupDomainController(const char *domain,
1027                                  uint32_t flags,
1028                                  struct wbcDomainControllerInfo **dc_info);
1029
1030 /**
1031  * @brief Get extended domain controller information
1032  *
1033  * @param domain        Name of the domain to query for a DC
1034  * @param guid          Guid of the domain to query for a DC
1035  * @param site          Site of the domain to query for a DC
1036  * @param flags         Bit flags used to control the domain location query
1037  * @param *dc_info      Pointer to the returned extended domain controller information
1038  *
1039  * @return #wbcErr
1040  **/
1041 wbcErr wbcLookupDomainControllerEx(const char *domain,
1042                                    struct wbcGuid *guid,
1043                                    const char *site,
1044                                    uint32_t flags,
1045                                    struct wbcDomainControllerInfoEx **dc_info);
1046
1047 /**********************************************************
1048  * Athenticate functions
1049  **********************************************************/
1050
1051 /**
1052  * @brief Authenticate a username/password pair
1053  *
1054  * @param username     Name of user to authenticate
1055  * @param password     Clear text password os user
1056  *
1057  * @return #wbcErr
1058  **/
1059 wbcErr wbcAuthenticateUser(const char *username,
1060                            const char *password);
1061
1062 /**
1063  * @brief Authenticate with more detailed information
1064  *
1065  * @param params       Input parameters, WBC_AUTH_USER_LEVEL_HASH
1066  *                     is not supported yet
1067  * @param info         Output details on WBC_ERR_SUCCESS
1068  * @param error        Output details on WBC_ERR_AUTH_ERROR
1069  *
1070  * @return #wbcErr
1071  **/
1072 wbcErr wbcAuthenticateUserEx(const struct wbcAuthUserParams *params,
1073                              struct wbcAuthUserInfo **info,
1074                              struct wbcAuthErrorInfo **error);
1075
1076 /**
1077  * @brief Logon a User
1078  *
1079  * @param[in]  params      Pointer to a wbcLogonUserParams structure
1080  * @param[out] info        Pointer to a pointer to a wbcLogonUserInfo structure
1081  * @param[out] error       Pointer to a pointer to a wbcAuthErrorInfo structure
1082  * @param[out] policy      Pointer to a pointer to a wbcUserPasswordPolicyInfo structure
1083  *
1084  * @return #wbcErr
1085  **/
1086 wbcErr wbcLogonUser(const struct wbcLogonUserParams *params,
1087                     struct wbcLogonUserInfo **info,
1088                     struct wbcAuthErrorInfo **error,
1089                     struct wbcUserPasswordPolicyInfo **policy);
1090
1091 /**
1092  * @brief Trigger a logoff notification to Winbind for a specific user
1093  *
1094  * @param username    Name of user to remove from Winbind's list of
1095  *                    logged on users.
1096  * @param uid         Uid assigned to the username
1097  * @param ccfilename  Absolute path to the Krb5 credentials cache to
1098  *                    be removed
1099  *
1100  * @return #wbcErr
1101  **/
1102 wbcErr wbcLogoffUser(const char *username,
1103                      uid_t uid,
1104                      const char *ccfilename);
1105
1106 /**
1107  * @brief Trigger an extended logoff notification to Winbind for a specific user
1108  *
1109  * @param params      A wbcLogoffUserParams structure
1110  * @param error       User output details on error
1111  *
1112  * @return #wbcErr
1113  **/
1114 wbcErr wbcLogoffUserEx(const struct wbcLogoffUserParams *params,
1115                        struct wbcAuthErrorInfo **error);
1116
1117 /**
1118  * @brief Change a password for a user
1119  *
1120  * @param username      Name of user to authenticate
1121  * @param old_password  Old clear text password of user
1122  * @param new_password  New clear text password of user
1123  *
1124  * @return #wbcErr
1125  **/
1126 wbcErr wbcChangeUserPassword(const char *username,
1127                              const char *old_password,
1128                              const char *new_password);
1129
1130 /**
1131  * @brief Change a password for a user with more detailed information upon
1132  *   failure
1133  *
1134  * @param params                Input parameters
1135  * @param error                 User output details on WBC_ERR_PWD_CHANGE_FAILED
1136  * @param reject_reason         New password reject reason on WBC_ERR_PWD_CHANGE_FAILED
1137  * @param policy                Password policy output details on WBC_ERR_PWD_CHANGE_FAILED
1138  *
1139  * @return #wbcErr
1140  **/
1141 wbcErr wbcChangeUserPasswordEx(const struct wbcChangePasswordParams *params,
1142                                struct wbcAuthErrorInfo **error,
1143                                enum wbcPasswordChangeRejectReason *reject_reason,
1144                                struct wbcUserPasswordPolicyInfo **policy);
1145
1146 /**
1147  * @brief Authenticate a user with cached credentials
1148  *
1149  * @param *params    Pointer to a wbcCredentialCacheParams structure
1150  * @param **info     Pointer to a pointer to a wbcCredentialCacheInfo structure
1151  * @param **error    Pointer to a pointer to a wbcAuthErrorInfo structure
1152  *
1153  * @return #wbcErr
1154  **/
1155 wbcErr wbcCredentialCache(struct wbcCredentialCacheParams *params,
1156                           struct wbcCredentialCacheInfo **info,
1157                           struct wbcAuthErrorInfo **error);
1158
1159 /**********************************************************
1160  * Resolve functions
1161  **********************************************************/
1162
1163 /**
1164  * @brief Resolve a NetbiosName via WINS
1165  *
1166  * @param name         Name to resolve
1167  * @param *ip          Pointer to the ip address string
1168  *
1169  * @return #wbcErr
1170  **/
1171 wbcErr wbcResolveWinsByName(const char *name, char **ip);
1172
1173 /**
1174  * @brief Resolve an IP address via WINS into a NetbiosName
1175  *
1176  * @param ip          The ip address string
1177  * @param *name       Pointer to the name
1178  *
1179  * @return #wbcErr
1180  *
1181  **/
1182 wbcErr wbcResolveWinsByIP(const char *ip, char **name);
1183
1184 /**********************************************************
1185  * Trusted domain functions
1186  **********************************************************/
1187
1188 /**
1189  * @brief Trigger a verification of the trust credentials of a specific domain
1190  *
1191  * @param *domain      The name of the domain.
1192  * @param error        Output details on WBC_ERR_AUTH_ERROR
1193  *
1194  * @return #wbcErr
1195  **/
1196 wbcErr wbcCheckTrustCredentials(const char *domain,
1197                                 struct wbcAuthErrorInfo **error);
1198
1199 /**********************************************************
1200  * Helper functions
1201  **********************************************************/
1202
1203 /**
1204  * @brief Initialize a named blob and add to list of blobs
1205  *
1206  * @param[in,out] num_blobs     Pointer to the number of blobs
1207  * @param[in,out] blobs         Pointer to an array of blobs
1208  * @param[in]     name          Name of the new named blob
1209  * @param[in]     flags         Flags of the new named blob
1210  * @param[in]     data          Blob data of new blob
1211  * @param[in]     length        Blob data length of new blob
1212  *
1213  * @return #wbcErr
1214  **/
1215 wbcErr wbcAddNamedBlob(size_t *num_blobs,
1216                        struct wbcNamedBlob **blobs,
1217                        const char *name,
1218                        uint32_t flags,
1219                        uint8_t *data,
1220                        size_t length);
1221
1222 #endif      /* _WBCLIENT_H */