secur32: Split the NTLM credential and context handles into separate objects.
[wine] / dlls / secur32 / secur32_priv.h
1 /*
2  * secur32 private definitions.
3  *
4  * Copyright (C) 2004 Juan Lang
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #ifndef __SECUR32_PRIV_H__
22 #define __SECUR32_PRIV_H__
23
24 #include <sys/types.h>
25 #include "wine/list.h"
26
27 /* Memory allocation functions for memory accessible by callers of secur32.
28  * The details are implementation specific.
29  */
30 #define SECUR32_ALLOC(bytes) HeapAlloc(GetProcessHeap(), 0, (bytes))
31 #define SECUR32_FREE(p)      HeapFree(GetProcessHeap(), 0, (p))
32
33 typedef struct _SecureProvider
34 {
35     struct list             entry;
36     BOOL                    loaded;
37     PWSTR                   moduleName;
38     HMODULE                 lib;
39     SecurityFunctionTableA  fnTableA;
40     SecurityFunctionTableW  fnTableW;
41 } SecureProvider;
42
43 typedef struct _SecurePackage
44 {
45     struct list     entry;
46     SecPkgInfoW     infoW;
47     SecureProvider *provider;
48 } SecurePackage;
49
50 typedef enum _helper_mode {
51     NTLM_SERVER,
52     NTLM_CLIENT,
53     NUM_HELPER_MODES
54 } HelperMode;
55
56 typedef struct tag_arc4_info {
57     unsigned char x, y;
58     unsigned char state[256];
59 } arc4_info;
60
61 typedef struct _NegoHelper {
62     pid_t helper_pid;
63     HelperMode mode;
64     int pipe_in;
65     int pipe_out;
66     int major;
67     int minor;
68     int micro;
69     char *com_buf;
70     int com_buf_size;
71     int com_buf_offset;
72     BYTE *session_key;
73     BOOL valid_session_key;
74     unsigned long neg_flags;
75     struct {
76         struct {
77             ULONG seq_num;
78             arc4_info *a4i;
79         } ntlm;
80         struct {
81             BYTE *send_sign_key;
82             BYTE *send_seal_key;
83             BYTE *recv_sign_key;
84             BYTE *recv_seal_key;
85             ULONG send_seq_no;
86             ULONG recv_seq_no;
87             arc4_info *send_a4i;
88             arc4_info *recv_a4i;
89         } ntlm2;
90     } crypt;
91 } NegoHelper, *PNegoHelper;
92
93 typedef enum _sign_direction {
94     NTLM_SEND,
95     NTLM_RECV
96 } SignDirection;
97
98 /* Allocates space for and initializes a new provider.  If fnTableA or fnTableW
99  * is non-NULL, assumes the provider is built-in (and is thus already loaded.)
100  * Otherwise moduleName must not be NULL.
101  * Returns a pointer to the stored provider entry, for use adding packages.
102  */
103 SecureProvider *SECUR32_addProvider(const SecurityFunctionTableA *fnTableA,
104  const SecurityFunctionTableW *fnTableW, PCWSTR moduleName);
105
106 /* Allocates space for and adds toAdd packages with the given provider.
107  * provider must not be NULL, and either infoA or infoW may be NULL, but not
108  * both.
109  */
110 void SECUR32_addPackages(SecureProvider *provider, ULONG toAdd,
111  const SecPkgInfoA *infoA, const SecPkgInfoW *infoW);
112
113 /* Tries to find the package named packageName.  If it finds it, implicitly
114  * loads the package if it isn't already loaded.
115  */
116 SecurePackage *SECUR32_findPackageW(PWSTR packageName);
117
118 /* Tries to find the package named packageName.  (Thunks to _findPackageW)
119  */
120 SecurePackage *SECUR32_findPackageA(PSTR packageName);
121
122 /* A few string helpers; will return NULL if str is NULL.  Free return with
123  * SECUR32_FREE */
124 PWSTR SECUR32_strdupW(PCWSTR str);
125 PWSTR SECUR32_AllocWideFromMultiByte(PCSTR str);
126 PSTR  SECUR32_AllocMultiByteFromWide(PCWSTR str);
127
128 /* Initialization functions for built-in providers */
129 void SECUR32_initSchannelSP(void);
130 void SECUR32_initNegotiateSP(void);
131 void SECUR32_initNTLMSP(void);
132
133 /* Functions from dispatcher.c used elsewhere in the code */
134 SECURITY_STATUS fork_helper(PNegoHelper *new_helper, const char *prog,
135         char * const argv[]);
136
137 SECURITY_STATUS run_helper(PNegoHelper helper, char *buffer,
138         unsigned int max_buflen, int *buflen);
139
140 void cleanup_helper(PNegoHelper helper);
141
142 void check_version(PNegoHelper helper);
143
144 /* Functions from base64_codec.c used elsewhere */
145 SECURITY_STATUS encodeBase64(PBYTE in_buf, int in_len, char* out_buf, 
146         int max_len, int *out_len);
147
148 SECURITY_STATUS decodeBase64(char *in_buf, int in_len, BYTE *out_buf,
149         int max_len, int *out_len);
150
151 /* Functions from util.c */
152 ULONG ComputeCrc32(const BYTE *pData, INT iLen, ULONG initial_crc);
153 SECURITY_STATUS SECUR32_CreateNTLMv1SessionKey(PBYTE password, int len, PBYTE session_key);
154 SECURITY_STATUS SECUR32_CreateNTLMv2SubKeys(PNegoHelper helper);
155 arc4_info *SECUR32_arc4Alloc(void);
156 void SECUR32_arc4Init(arc4_info *a4i, const BYTE *key, unsigned int keyLen);
157 void SECUR32_arc4Process(arc4_info *a4i, BYTE *inoutString, unsigned int length);
158 void SECUR32_arc4Cleanup(arc4_info *a4i);
159
160 /* NTLMSSP flags indicating the negotiated features */
161 #define NTLMSSP_NEGOTIATE_UNICODE                   0x00000001
162 #define NTLMSSP_NEGOTIATE_OEM                       0x00000002
163 #define NTLMSSP_REQUEST_TARGET                      0x00000004
164 #define NTLMSSP_NEGOTIATE_SIGN                      0x00000010
165 #define NTLMSSP_NEGOTIATE_SEAL                      0x00000020
166 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE            0x00000040
167 #define NTLMSSP_NEGOTIATE_LM_SESSION_KEY            0x00000080
168 #define NTLMSSP_NEGOTIATE_NTLM                      0x00000200
169 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED           0x00001000
170 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED      0x00002000
171 #define NTLMSSP_NEGOTIATE_LOCAL_CALL                0x00004000
172 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN               0x00008000
173 #define NTLMSSP_NEGOTIATE_TARGET_TYPE_DOMAIN        0x00010000
174 #define NTLMSSP_NEGOTIATE_TARGET_TYPE_SERVER        0x00020000
175 #define NTLMSSP_NEGOTIATE_NTLM2                     0x00080000
176 #define NTLMSSP_NEGOTIATE_TARGET_INFO               0x00800000
177 #define NTLMSSP_NEGOTIATE_128                       0x20000000
178 #define NTLMSSP_NEGOTIATE_KEY_EXCHANGE              0x40000000
179 #define NTLMSSP_NEGOTIATE_56                        0x80000000
180 #endif /* ndef __SECUR32_PRIV_H__ */