reactos/include/psdk/wincred.h

   1 /*
   2  * Copyright (C) 2006 Robert Shearman (for CodeWeavers)
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef _WINCRED_H_
  20 #define _WINCRED_H_
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 #ifdef _ADVAPI32_
  27 #define WINADVAPI
  28 #else
  29 #define WINADVAPI DECLSPEC_IMPORT
  30 #endif
  31
  32 #ifndef __SECHANDLE_DEFINED__
  33 #define __SECHANDLE_DEFINED__
  34 typedef struct _SecHandle
  35 {
  36     ULONG_PTR dwLower;
  37     ULONG_PTR dwUpper;
  38 } SecHandle, *PSecHandle;
  39 #endif
  40
  41 #ifndef __WINE_CTXTHANDLE_DEFINED__
  42 #define __WINE_CTXTHANDLE_DEFINED__
  43 typedef SecHandle CtxtHandle;
  44 typedef PSecHandle PCtxtHandle;
  45 #endif
  46
  47 typedef struct _CREDENTIAL_ATTRIBUTEA
  48 {
  49     LPSTR Keyword;
  50     DWORD Flags;
  51     DWORD ValueSize;
  52     LPBYTE Value;
  53 } CREDENTIAL_ATTRIBUTEA, *PCREDENTIAL_ATTRIBUTEA;
  54
  55 typedef struct _CREDENTIAL_ATTRIBUTEW
  56 {
  57     LPWSTR Keyword;
  58     DWORD Flags;
  59     DWORD ValueSize;
  60     LPBYTE Value;
  61 } CREDENTIAL_ATTRIBUTEW, *PCREDENTIAL_ATTRIBUTEW;
  62
  63 DECL_WINELIB_TYPE_AW(CREDENTIAL_ATTRIBUTE)
  64 DECL_WINELIB_TYPE_AW(PCREDENTIAL_ATTRIBUTE)
  65
  66 typedef struct _CREDENTIALA
  67 {
  68     DWORD Flags;
  69     DWORD Type;
  70     LPSTR TargetName;
  71     LPSTR Comment;
  72     FILETIME LastWritten;
  73     DWORD CredentialBlobSize;
  74     _Field_size_bytes_(CredentialBlobSize) LPBYTE CredentialBlob;
  75     DWORD Persist;
  76     DWORD AttributeCount;
  77     PCREDENTIAL_ATTRIBUTEA Attributes;
  78     LPSTR TargetAlias;
  79     LPSTR UserName;
  80 } CREDENTIALA, *PCREDENTIALA;
  81
  82 typedef struct _CREDENTIALW
  83 {
  84     DWORD Flags;
  85     DWORD Type;
  86     LPWSTR TargetName;
  87     LPWSTR Comment;
  88     FILETIME LastWritten;
  89     DWORD CredentialBlobSize;
  90     LPBYTE CredentialBlob;
  91     DWORD Persist;
  92     DWORD AttributeCount;
  93     PCREDENTIAL_ATTRIBUTEW Attributes;
  94     LPWSTR TargetAlias;
  95     LPWSTR UserName;
  96 } CREDENTIALW, *PCREDENTIALW;
  97
  98 DECL_WINELIB_TYPE_AW(CREDENTIAL)
  99 DECL_WINELIB_TYPE_AW(PCREDENTIAL)
 100
 101 typedef struct _CREDENTIAL_TARGET_INFORMATIONA
 102 {
 103     LPSTR TargetName;
 104     LPSTR NetbiosServerName;
 105     LPSTR DnsServerName;
 106     LPSTR NetbiosDomainName;
 107     LPSTR DnsDomainName;
 108     LPSTR DnsTreeName;
 109     LPSTR PackageName;
 110     DWORD Flags;
 111     DWORD CredTypeCount;
 112     LPDWORD CredTypes;
 113 } CREDENTIAL_TARGET_INFORMATIONA, *PCREDENTIAL_TARGET_INFORMATIONA;
 114
 115 typedef struct _CREDENTIAL_TARGET_INFORMATIONW
 116 {
 117     LPWSTR TargetName;
 118     LPWSTR NetbiosServerName;
 119     LPWSTR DnsServerName;
 120     LPWSTR NetbiosDomainName;
 121     LPWSTR DnsDomainName;
 122     LPWSTR DnsTreeName;
 123     LPWSTR PackageName;
 124     DWORD Flags;
 125     DWORD CredTypeCount;
 126     LPDWORD CredTypes;
 127 } CREDENTIAL_TARGET_INFORMATIONW, *PCREDENTIAL_TARGET_INFORMATIONW;
 128
 129 DECL_WINELIB_TYPE_AW(CREDENTIAL_TARGET_INFORMATION)
 130 DECL_WINELIB_TYPE_AW(PCREDENTIAL_TARGET_INFORMATION)
 131
 132 typedef struct _CREDUI_INFOA
 133 {
 134     DWORD cbSize;
 135     HWND hwndParent;
 136     PCSTR pszMessageText;
 137     PCSTR pszCaptionText;
 138     HBITMAP hbmBanner;
 139 } CREDUI_INFOA, *PCREDUI_INFOA;
 140
 141 typedef struct _CREDUI_INFOW
 142 {
 143     DWORD cbSize;
 144     HWND hwndParent;
 145     PCWSTR pszMessageText;
 146     PCWSTR pszCaptionText;
 147     HBITMAP hbmBanner;
 148 } CREDUI_INFOW, *PCREDUI_INFOW;
 149
 150 DECL_WINELIB_TYPE_AW(CREDUI_INFO)
 151 DECL_WINELIB_TYPE_AW(PCREDUI_INFO)
 152
 153 typedef enum _CRED_MARSHAL_TYPE
 154 {
 155     CertCredential = 1,
 156     UsernameTargetCredential,
 157     BinaryBlobCredential
 158 } CRED_MARSHAL_TYPE, *PCRED_MARSHAL_TYPE;
 159
 160 #define CERT_HASH_LENGTH    20
 161
 162 typedef struct _CERT_CREDENTIAL_INFO
 163 {
 164     ULONG cbSize;
 165     UCHAR rgbHashOfCert[CERT_HASH_LENGTH];
 166 } CERT_CREDENTIAL_INFO, *PCERT_CREDENTIAL_INFO;
 167
 168 typedef struct _USERNAME_TARGET_CREDENTIAL_INFO
 169 {
 170     LPWSTR UserName;
 171 } USERNAME_TARGET_CREDENTIAL_INFO;
 172
 173 typedef struct _BINARY_BLOB_CREDENTIAL_INFO
 174 {
 175     ULONG cbBlob;
 176     LPBYTE pbBlob;
 177 } BINARY_BLOB_CREDENTIAL_INFO, *PBINARY_BLOB_CREDENTIAL_INFO;
 178
 179 #define CRED_MAX_STRING_LENGTH              256
 180 #define CRED_MAX_USERNAME_LENGTH            513
 181 #define CRED_MAX_GENERIC_TARGET_NAME_LENGTH 32767
 182 #define CRED_MAX_DOMAIN_TARGET_NAME_LENGTH  337
 183 #define CRED_MAX_VALUE_SIZE                 256
 184 #define CRED_MAX_ATTRIBUTES                 64
 185
 186 #define CRED_MAX_BLOB_SIZE                  512
 187
 188 #define CREDUI_MAX_MESSAGE_LENGTH 32767
 189 #define CREDUI_MAX_CAPTION_LENGTH 128
 190 #define CREDUI_MAX_GENERIC_TARGET_LENGTH CRED_MAX_GENERIC_TARGET_NAME_LENGTH
 191 #define CREDUI_MAX_DOMAIN_TARGET_LENGTH CRED_MAX_DOMAIN_TARGET_LENGTH
 192 #define CREDUI_MAX_USERNAME_LENGTH CRED_MAX_USERNAME_LENGTH
 193 #define CREDUI_MAX_PASSWORD_LENGTH (CRED_MAX_CREDENTIAL_BLOB_SIZE / 2)
 194
 195 /* flags for CREDENTIAL::Flags */
 196 #define CRED_FLAGS_PASSWORD_FOR_CERT                0x0001
 197 #define CRED_FLAGS_PROMPT_NOW                       0x0002
 198 #define CRED_FLAGS_USERNAME_TARGET                  0x0004
 199 #define CRED_FLAGS_OWF_CRED_BLOB                    0x0008
 200 #define CRED_FLAGS_VALID_FLAGS                      0x000f
 201
 202 /* values for CREDENTIAL::Type */
 203 #define CRED_TYPE_GENERIC                           1
 204 #define CRED_TYPE_DOMAIN_PASSWORD                   2
 205 #define CRED_TYPE_DOMAIN_CERTIFICATE                3
 206 #define CRED_TYPE_DOMAIN_VISIBLE_PASSWORD           4
 207 #define CRED_TYPE_GENERIC_CERTIFICATE               5
 208 #define CRED_TYPE_MAXIMUM                           6
 209 #define CRED_TYPE_MAXIMUM_EX                        (CRED_TYPE_MAXIMUM+1000)
 210
 211 /* values for CREDENTIAL::Persist */
 212 #define CRED_PERSIST_NONE                           0
 213 #define CRED_PERSIST_SESSION                        1
 214 #define CRED_PERSIST_LOCAL_MACHINE                  2
 215 #define CRED_PERSIST_ENTERPRISE                     3
 216
 217 /* values for CREDENTIAL_TARGET_INFORMATION::Flags */
 218 #define CRED_TI_SERVER_FORMAT_UNKNOWN               1
 219 #define CRED_TI_DOMAIN_FORMAT_UNKNOWN               2
 220 #define CRED_TI_ONLY_PASSWORD_REQUIRED              4
 221
 222 #define CREDUI_FLAGS_INCORRECT_PASSWORD             0x00000001
 223 #define CREDUI_FLAGS_DO_NOT_PERSIST                 0x00000002
 224 #define CREDUI_FLAGS_REQUEST_ADMINISTRATOR          0x00000004
 225 #define CREDUI_FLAGS_EXCLUDE_CERTIFICATES           0x00000008
 226 #define CREDUI_FLAGS_REQUIRE_CERTIFICATE            0x00000010
 227 #define CREDUI_FLAGS_SHOW_SAVE_CHECK_BOX            0x00000040
 228 #define CREDUI_FLAGS_ALWAYS_SHOW_UI                 0x00000080
 229 #define CREDUI_FLAGS_REQUIRE_SMARTCARD              0x00000100
 230 #define CREDUI_FLAGS_PASSWORD_ONLY_OK               0x00000200
 231 #define CREDUI_FLAGS_VALIDATE_USERNAME              0x00000400
 232 #define CREDUI_FLAGS_COMPLETE_USERNAME              0x00000800
 233 #define CREDUI_FLAGS_PERSIST                        0x00001000
 234 #define CREDUI_FLAGS_SERVER_CREDENTIAL              0x00004000
 235 #define CREDUI_FLAGS_EXPECT_CONFIRMATION            0x00020000
 236 #define CREDUI_FLAGS_GENERIC_CREDENTIALS            0x00040000
 237 #define CREDUI_FLAGS_USERNAME_TARGET_CREDENTIALS    0x00080000
 238 #define CREDUI_FLAGS_KEEP_USERNAME                  0x00100000
 239
 240 /* flags for CredWrite and CredWriteDomainCredentials */
 241 #define CRED_PRESERVE_CREDENTIAL_BLOB               0x00000001
 242
 243 WINADVAPI BOOL WINAPI CredDeleteA(_In_ LPCSTR, _In_ DWORD, _Reserved_ DWORD);
 244 WINADVAPI BOOL WINAPI CredDeleteW(_In_ LPCWSTR, _In_ DWORD, _Reserved_ DWORD);
 245 #define CredDelete WINELIB_NAME_AW(CredDelete)
 246
 247 WINADVAPI
 248 BOOL
 249 WINAPI
 250 CredEnumerateA(
 251   _In_opt_ LPCSTR,
 252   _Reserved_ DWORD,
 253   _Out_ DWORD *Count,
 254   _Outptr_result_buffer_(*Count) PCREDENTIALA **);
 255
 256 WINADVAPI
 257 BOOL
 258 WINAPI
 259 CredEnumerateW(
 260   _In_opt_ LPCWSTR,
 261   _Reserved_ DWORD,
 262   _Out_ DWORD *Count,
 263   _Outptr_result_buffer_(*Count) PCREDENTIALW **);
 264
 265 #define CredEnumerate WINELIB_NAME_AW(CredEnumerate)
 266
 267 WINADVAPI VOID WINAPI CredFree(_In_ PVOID);
 268
 269 WINADVAPI
 270 BOOL
 271 WINAPI
 272 CredGetSessionTypes(
 273   _In_ DWORD MaximumPersistCount,
 274   _Out_writes_(MaximumPersistCount) LPDWORD);
 275
 276 WINADVAPI BOOL WINAPI CredIsMarshaledCredentialA(_In_ LPCSTR);
 277 WINADVAPI BOOL WINAPI CredIsMarshaledCredentialW(_In_ LPCWSTR);
 278 #define CredIsMarshaledCredential WINELIB_NAME_AW(CredIsMarshaledCredential)
 279
 280 WINADVAPI
 281 BOOL
 282 WINAPI
 283 CredMarshalCredentialA(
 284   _In_ CRED_MARSHAL_TYPE,
 285   _In_ PVOID,
 286   _Out_ LPSTR *);
 287
 288 WINADVAPI
 289 BOOL
 290 WINAPI
 291 CredMarshalCredentialW(
 292   _In_ CRED_MARSHAL_TYPE,
 293   _In_ PVOID,
 294   _Out_ LPWSTR *);
 295
 296 #define CredMarshalCredential WINELIB_NAME_AW(CredMarshalCredential)
 297
 298 WINADVAPI
 299 BOOL
 300 WINAPI
 301 CredReadA(
 302   _In_ LPCSTR,
 303   _In_ DWORD,
 304   _Reserved_ DWORD,
 305   _Out_ PCREDENTIALA *);
 306
 307 WINADVAPI
 308 BOOL
 309 WINAPI
 310 CredReadW(
 311   _In_ LPCWSTR,
 312   _In_ DWORD,
 313   _Reserved_ DWORD,
 314   _Out_ PCREDENTIALW *);
 315
 316 #define CredRead WINELIB_NAME_AW(CredRead)
 317
 318 WINADVAPI
 319 BOOL
 320 WINAPI
 321 CredReadDomainCredentialsA(
 322   _In_ PCREDENTIAL_TARGET_INFORMATIONA,
 323   _In_ DWORD,
 324   _Out_ DWORD *Count,
 325   _Outptr_result_buffer_(*Count) PCREDENTIALA **);
 326
 327 WINADVAPI
 328 BOOL
 329 WINAPI
 330 CredReadDomainCredentialsW(
 331   _In_ PCREDENTIAL_TARGET_INFORMATIONW,
 332   _In_ DWORD,
 333   _Out_ DWORD *Count,
 334   _Outptr_result_buffer_(*Count) PCREDENTIALW **);
 335
 336 #define CredReadDomainCredentials WINELIB_NAME_AW(CredReadDomainCredentials)
 337
 338 WINADVAPI
 339 BOOL
 340 WINAPI
 341 CredRenameA(
 342   _In_ LPCSTR,
 343   _In_ LPCSTR,
 344   _In_ DWORD,
 345   _Reserved_ DWORD);
 346
 347 WINADVAPI
 348 BOOL
 349 WINAPI
 350 CredRenameW(
 351   _In_ LPCWSTR,
 352   _In_ LPCWSTR,
 353   _In_ DWORD,
 354   _Reserved_ DWORD);
 355
 356 #define CredRename WINELIB_NAME_AW(CredRename)
 357
 358 WINADVAPI
 359 BOOL
 360 WINAPI
 361 CredUnmarshalCredentialA(
 362   _In_ LPCSTR,
 363   _Out_ PCRED_MARSHAL_TYPE,
 364   _Out_ PVOID *);
 365
 366 WINADVAPI
 367 BOOL
 368 WINAPI
 369 CredUnmarshalCredentialW(
 370   _In_ LPCWSTR,
 371   _Out_ PCRED_MARSHAL_TYPE,
 372   _Out_ PVOID *);
 373
 374 #define CredUnmarshalCredential WINELIB_NAME_AW(CredUnmarshalCredential)
 375
 376 WINADVAPI BOOL WINAPI CredWriteA(_In_ PCREDENTIALA, _In_ DWORD);
 377 WINADVAPI BOOL WINAPI CredWriteW(_In_ PCREDENTIALW, _In_ DWORD);
 378 #define CredWrite WINELIB_NAME_AW(CredWrite)
 379
 380 DWORD
 381 WINAPI
 382 CredUICmdLinePromptForCredentialsW(
 383   _In_opt_ PCWSTR,
 384   _Reserved_ PCtxtHandle,
 385   _In_ DWORD,
 386   _Inout_updates_(ulUserBufferSize) PWSTR,
 387   _In_ ULONG ulUserBufferSize,
 388   _Inout_updates_(ulPasswordBufferSize) PWSTR,
 389   _In_ ULONG ulPasswordBufferSize,
 390   _Inout_opt_ PBOOL,
 391   _In_ DWORD);
 392
 393 DWORD
 394 WINAPI
 395 CredUICmdLinePromptForCredentialsA(
 396   _In_opt_ PCSTR,
 397   _Reserved_ PCtxtHandle,
 398   _In_ DWORD,
 399   _Inout_updates_(ulUserBufferSize) PSTR,
 400   _In_ ULONG ulUserBufferSize,
 401   _Inout_updates_(ulPasswordBufferSize) PSTR,
 402   _In_ ULONG ulPasswordBufferSize,
 403   _Inout_opt_ PBOOL,
 404   _In_ DWORD);
 405
 406 #define CredUICmdLinePromptForCredentials WINELIB_NAME_AW(CredUICmdLinePromptForCredentials)
 407
 408 DWORD WINAPI CredUIConfirmCredentialsW(_In_ PCWSTR, _In_ BOOL);
 409 DWORD WINAPI CredUIConfirmCredentialsA(_In_ PCSTR, _In_ BOOL);
 410 #define CredUIConfirmCredentials WINELIB_NAME_AW(CredUIConfirmCredentials)
 411
 412 DWORD
 413 WINAPI
 414 CredUIParseUserNameW(
 415   _In_ PCWSTR,
 416   _Out_writes_(userBufferSize) PWSTR,
 417   _In_ ULONG userBufferSize,
 418   _Out_writes_(domainBufferSize) PWSTR,
 419   _In_ ULONG domainBufferSize);
 420
 421 DWORD
 422 WINAPI
 423 CredUIParseUserNameA(
 424   _In_ PCSTR,
 425   _Out_writes_(userBufferSize) PSTR,
 426   _In_ ULONG userBufferSize,
 427   _Out_writes_(domainBufferSize) PSTR,
 428   _In_ ULONG domainBufferSize);
 429
 430 #define CredUIParseUserName WINELIB_NAME_AW(CredUIParseUserName)
 431
 432 DWORD
 433 WINAPI
 434 CredUIPromptForCredentialsW(
 435   _In_opt_ PCREDUI_INFOW,
 436   _In_opt_ PCWSTR,
 437   _Reserved_ PCtxtHandle,
 438   _In_ DWORD,
 439   _Inout_updates_(ulUserNameBufferSize) PWSTR,
 440   _In_ ULONG ulUserNameBufferSize,
 441   _Inout_updates_(ulPasswordBufferSize) PWSTR,
 442   _In_ ULONG ulPasswordBufferSize,
 443   _Inout_opt_ PBOOL,
 444   _In_ DWORD);
 445
 446 DWORD
 447 WINAPI
 448 CredUIPromptForCredentialsA(
 449   _In_opt_ PCREDUI_INFOA,
 450   _In_opt_ PCSTR,
 451   _Reserved_ PCtxtHandle,
 452   _In_ DWORD,
 453   _Inout_updates_(ulUserNameBufferSize) PSTR,
 454   _In_ ULONG ulUserNameBufferSize,
 455   _Inout_updates_(ulPasswordBufferSize) PSTR,
 456   _In_ ULONG ulPasswordBufferSize,
 457   _Inout_opt_ PBOOL,
 458   _In_ DWORD);
 459
 460 #define CredUIPromptForCredentials WINELIB_NAME_AW(CredUIPromptForCredentials)
 461
 462 DWORD
 463 WINAPI
 464 CredUIStoreSSOCredW(
 465   _In_opt_ PCWSTR,
 466   _In_ PCWSTR,
 467   _In_ PCWSTR,
 468    _In_ BOOL);
 469
 470 /* Note: no CredUIStoreSSOCredA in PSDK header */
 471 DWORD WINAPI CredUIReadSSOCredW(_In_opt_ PCWSTR, _Outptr_ PWSTR*);
 472 /* Note: no CredUIReadSSOCredA in PSDK header */
 473
 474 #ifdef __cplusplus
 475 }
 476 #endif
 477
 478 #endif /* _WINCRED_H_ */