nsswitch/libwbclient/wbclient.h

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