secur32: Add an option to disable use of cached Samba credentials.
[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 <limits.h>
26 #include "wine/list.h"
27 #include "schannel.h"
28
29 typedef struct _SecureProvider
30 {
31     struct list             entry;
32     BOOL                    loaded;
33     PWSTR                   moduleName;
34     HMODULE                 lib;
35     SecurityFunctionTableA  fnTableA;
36     SecurityFunctionTableW  fnTableW;
37 } SecureProvider;
38
39 typedef struct _SecurePackage
40 {
41     struct list     entry;
42     SecPkgInfoW     infoW;
43     SecureProvider *provider;
44 } SecurePackage;
45
46 typedef enum _helper_mode {
47     NTLM_SERVER,
48     NTLM_CLIENT,
49     NUM_HELPER_MODES
50 } HelperMode;
51
52 typedef struct tag_arc4_info {
53     unsigned char x, y;
54     unsigned char state[256];
55 } arc4_info;
56
57 typedef struct _NegoHelper {
58     pid_t helper_pid;
59     HelperMode mode;
60     int pipe_in;
61     int pipe_out;
62     int major;
63     int minor;
64     int micro;
65     char *com_buf;
66     int com_buf_size;
67     int com_buf_offset;
68     BYTE *session_key;
69     ULONG neg_flags;
70     struct {
71         struct {
72             ULONG seq_num;
73             arc4_info *a4i;
74         } ntlm;
75         struct {
76             BYTE *send_sign_key;
77             BYTE *send_seal_key;
78             BYTE *recv_sign_key;
79             BYTE *recv_seal_key;
80             ULONG send_seq_no;
81             ULONG recv_seq_no;
82             arc4_info *send_a4i;
83             arc4_info *recv_a4i;
84         } ntlm2;
85     } crypt;
86 } NegoHelper, *PNegoHelper;
87
88 typedef enum _sign_direction {
89     NTLM_SEND,
90     NTLM_RECV
91 } SignDirection;
92
93 /* Allocates space for and initializes a new provider.  If fnTableA or fnTableW
94  * is non-NULL, assumes the provider is built-in, and if moduleName is non-NULL,
95  * means must load the LSA/user mode functions tables from external SSP/AP module.
96  * Otherwise moduleName must not be NULL.
97  * Returns a pointer to the stored provider entry, for use adding packages.
98  */
99 SecureProvider *SECUR32_addProvider(const SecurityFunctionTableA *fnTableA,
100  const SecurityFunctionTableW *fnTableW, PCWSTR moduleName) DECLSPEC_HIDDEN;
101
102 /* Allocates space for and adds toAdd packages with the given provider.
103  * provider must not be NULL, and either infoA or infoW may be NULL, but not
104  * both.
105  */
106 void SECUR32_addPackages(SecureProvider *provider, ULONG toAdd,
107  const SecPkgInfoA *infoA, const SecPkgInfoW *infoW) DECLSPEC_HIDDEN;
108
109 /* Tries to find the package named packageName.  If it finds it, implicitly
110  * loads the package if it isn't already loaded.
111  */
112 SecurePackage *SECUR32_findPackageW(PCWSTR packageName) DECLSPEC_HIDDEN;
113
114 /* Tries to find the package named packageName.  (Thunks to _findPackageW)
115  */
116 SecurePackage *SECUR32_findPackageA(PCSTR packageName) DECLSPEC_HIDDEN;
117
118 /* A few string helpers; will return NULL if str is NULL.  Free return with
119  * HeapFree */
120 PWSTR SECUR32_AllocWideFromMultiByte(PCSTR str) DECLSPEC_HIDDEN;
121 PSTR  SECUR32_AllocMultiByteFromWide(PCWSTR str) DECLSPEC_HIDDEN;
122
123 /* Initialization functions for built-in providers */
124 void SECUR32_initSchannelSP(void) DECLSPEC_HIDDEN;
125 void SECUR32_initNegotiateSP(void) DECLSPEC_HIDDEN;
126 void SECUR32_initNTLMSP(void) DECLSPEC_HIDDEN;
127
128 /* Cleanup functions for built-in providers */
129 void SECUR32_deinitSchannelSP(void) DECLSPEC_HIDDEN;
130
131 /* Functions from dispatcher.c used elsewhere in the code */
132 SECURITY_STATUS fork_helper(PNegoHelper *new_helper, const char *prog,
133         char * const argv[]) DECLSPEC_HIDDEN;
134
135 SECURITY_STATUS run_helper(PNegoHelper helper, char *buffer,
136         unsigned int max_buflen, int *buflen) DECLSPEC_HIDDEN;
137
138 void cleanup_helper(PNegoHelper helper) DECLSPEC_HIDDEN;
139
140 void check_version(PNegoHelper helper) DECLSPEC_HIDDEN;
141
142 /* Functions from base64_codec.c used elsewhere */
143 SECURITY_STATUS encodeBase64(PBYTE in_buf, int in_len, char* out_buf,
144         int max_len, int *out_len) DECLSPEC_HIDDEN;
145
146 SECURITY_STATUS decodeBase64(char *in_buf, int in_len, BYTE *out_buf,
147         int max_len, int *out_len) DECLSPEC_HIDDEN;
148
149 /* Functions from util.c */
150 ULONG ComputeCrc32(const BYTE *pData, INT iLen, ULONG initial_crc) DECLSPEC_HIDDEN;
151 SECURITY_STATUS SECUR32_CreateNTLM1SessionKey(PBYTE password, int len, PBYTE session_key) DECLSPEC_HIDDEN;
152 SECURITY_STATUS SECUR32_CreateNTLM2SubKeys(PNegoHelper helper) DECLSPEC_HIDDEN;
153 arc4_info *SECUR32_arc4Alloc(void) DECLSPEC_HIDDEN;
154 void SECUR32_arc4Init(arc4_info *a4i, const BYTE *key, unsigned int keyLen) DECLSPEC_HIDDEN;
155 void SECUR32_arc4Process(arc4_info *a4i, BYTE *inoutString, unsigned int length) DECLSPEC_HIDDEN;
156 void SECUR32_arc4Cleanup(arc4_info *a4i) DECLSPEC_HIDDEN;
157
158 /* NTLMSSP flags indicating the negotiated features */
159 #define NTLMSSP_NEGOTIATE_UNICODE                   0x00000001
160 #define NTLMSSP_NEGOTIATE_OEM                       0x00000002
161 #define NTLMSSP_REQUEST_TARGET                      0x00000004
162 #define NTLMSSP_NEGOTIATE_SIGN                      0x00000010
163 #define NTLMSSP_NEGOTIATE_SEAL                      0x00000020
164 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE            0x00000040
165 #define NTLMSSP_NEGOTIATE_LM_SESSION_KEY            0x00000080
166 #define NTLMSSP_NEGOTIATE_NTLM                      0x00000200
167 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED           0x00001000
168 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED      0x00002000
169 #define NTLMSSP_NEGOTIATE_LOCAL_CALL                0x00004000
170 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN               0x00008000
171 #define NTLMSSP_NEGOTIATE_TARGET_TYPE_DOMAIN        0x00010000
172 #define NTLMSSP_NEGOTIATE_TARGET_TYPE_SERVER        0x00020000
173 #define NTLMSSP_NEGOTIATE_NTLM2                     0x00080000
174 #define NTLMSSP_NEGOTIATE_TARGET_INFO               0x00800000
175 #define NTLMSSP_NEGOTIATE_128                       0x20000000
176 #define NTLMSSP_NEGOTIATE_KEY_EXCHANGE              0x40000000
177 #define NTLMSSP_NEGOTIATE_56                        0x80000000
178
179
180 /* schannel internal interface */
181 typedef struct schan_imp_session_opaque *schan_imp_session;
182 typedef struct schan_imp_certificate_credentials_opaque *schan_imp_certificate_credentials;
183
184 struct schan_transport;
185
186 struct schan_buffers
187 {
188     SIZE_T offset;
189     SIZE_T limit;
190     const SecBufferDesc *desc;
191     int current_buffer_idx;
192     BOOL allow_buffer_resize;
193     int (*get_next_buffer)(const struct schan_transport *, struct schan_buffers *);
194 };
195
196 struct schan_transport
197 {
198     struct schan_context *ctx;
199     struct schan_buffers in;
200     struct schan_buffers out;
201 };
202
203 char *schan_get_buffer(const struct schan_transport *t, struct schan_buffers *s, SIZE_T *count) DECLSPEC_HIDDEN;
204 extern int schan_pull(struct schan_transport *t, void *buff, size_t *buff_len) DECLSPEC_HIDDEN;
205 extern int schan_push(struct schan_transport *t, const void *buff, size_t *buff_len) DECLSPEC_HIDDEN;
206
207 extern schan_imp_session schan_session_for_transport(struct schan_transport* t) DECLSPEC_HIDDEN;
208
209 /* schannel implementation interface */
210 extern BOOL schan_imp_create_session(schan_imp_session *session, BOOL is_server,
211                                      schan_imp_certificate_credentials cred) DECLSPEC_HIDDEN;
212 extern void schan_imp_dispose_session(schan_imp_session session) DECLSPEC_HIDDEN;
213 extern void schan_imp_set_session_transport(schan_imp_session session,
214                                             struct schan_transport *t) DECLSPEC_HIDDEN;
215 extern SECURITY_STATUS schan_imp_handshake(schan_imp_session session) DECLSPEC_HIDDEN;
216 extern unsigned int schan_imp_get_session_cipher_block_size(schan_imp_session session) DECLSPEC_HIDDEN;
217 extern unsigned int schan_imp_get_max_message_size(schan_imp_session session) DECLSPEC_HIDDEN;
218 extern SECURITY_STATUS schan_imp_get_connection_info(schan_imp_session session,
219                                                      SecPkgContext_ConnectionInfo *info) DECLSPEC_HIDDEN;
220 extern SECURITY_STATUS schan_imp_get_session_peer_certificate(schan_imp_session session,
221                                                               PCCERT_CONTEXT *cert) DECLSPEC_HIDDEN;
222 extern SECURITY_STATUS schan_imp_send(schan_imp_session session, const void *buffer,
223                                       SIZE_T *length) DECLSPEC_HIDDEN;
224 extern SECURITY_STATUS schan_imp_recv(schan_imp_session session, void *buffer,
225                                       SIZE_T *length) DECLSPEC_HIDDEN;
226 extern BOOL schan_imp_allocate_certificate_credentials(schan_imp_certificate_credentials *c) DECLSPEC_HIDDEN;
227 extern void schan_imp_free_certificate_credentials(schan_imp_certificate_credentials c) DECLSPEC_HIDDEN;
228 extern BOOL schan_imp_init(void) DECLSPEC_HIDDEN;
229 extern void schan_imp_deinit(void) DECLSPEC_HIDDEN;
230
231
232 #endif /* ndef __SECUR32_PRIV_H__ */