dangling-comments-are-bad-20040504
[openafs.git] / src / WINNT / afsd / afskfw-int.h
1 /*
2  * Copyright (c) 2003 SkyRope, LLC
3  * All rights reserved.
4  * 
5  * Redistribution and use in source and binary forms, with or without 
6  * modification, are permitted provided that the following conditions are met:
7  * 
8  * - Redistributions of source code must retain the above copyright notice, 
9  *   this list of conditions and the following disclaimer.
10  * - Redistributions in binary form must reproduce the above copyright notice, 
11  *   this list of conditions and the following disclaimer in the documentation 
12  *   and/or other materials provided with the distribution.
13  * - Neither the name of Skyrope, LLC nor the names of its contributors may be 
14  *   used to endorse or promote products derived from this software without 
15  *   specific prior written permission from Skyrope, LLC.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Portions of this code are derived from portions of the MIT
30  * Leash Ticket Manager and LoadFuncs utilities.  For these portions the
31  * following copyright applies.
32  *
33  * Copyright (c) 2003,2004 by the Massachusetts Institute of Technology.
34  * All rights reserved.
35  *
36  * Export of this software from the United States of America may
37  *   require a specific license from the United States Government.
38  *   It is the responsibility of any person or organization contemplating
39  *   export to obtain such a license before exporting.
40  *
41  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
42  * distribute this software and its documentation for any purpose and
43  * without fee is hereby granted, provided that the above copyright
44  * notice appear in all copies and that both that copyright notice and
45  * this permission notice appear in supporting documentation, and that
46  * the name of M.I.T. not be used in advertising or publicity pertaining
47  * to distribution of the software without specific, written prior
48  * permission.  Furthermore if you modify this software you must label
49  * your software as modified software and not distribute it in such a
50  * fashion that it might be confused with the original M.I.T. software.
51  * M.I.T. makes no representations about the suitability of
52  * this software for any purpose.  It is provided "as is" without express
53  * or implied warranty.
54  *
55  */
56
57 #ifndef AFSKRB5_INT_H
58 #define AFSKRB5_INT_H
59
60 #include <windows.h>
61 #ifdef USE_MS2MIT
62 #define SECURITY_WIN32
63 #include <security.h>
64 #include <ntsecapi.h>
65 #endif /* USE_MS2MIT */
66 #include <stdio.h>
67 #include <string.h>
68 #include <time.h>
69 #include <winsock2.h>
70
71 #ifdef USE_MS2MIT
72 #include <loadfuncs-lsa.h>
73 #endif /* USE_MS2MIT */
74
75 #include <afs/stds.h>
76 #include <krb5.h>
77
78 #include <rxkad.h>
79
80 /* Defined in the KRBV4W32 version of krb.h but not the Kerberos V version */
81 /* Required for some of the loadfuncs headers */
82 typedef struct ktext far *KTEXT;
83 typedef struct ktext far *KTEXT_FP;
84 #include <KerberosIV/krb.h>
85
86 /* AFS has its own version of com_err.h */
87 typedef afs_int32 errcode_t;
88
89 #include <loadfuncs-com_err.h>
90 #include <loadfuncs-krb5.h>
91 #include <loadfuncs-profile.h>
92 #include <loadfuncs-krb.h>
93 #include <loadfuncs-krb524.h>
94 #include <loadfuncs-afs36.h>
95 #include <loadfuncs-leash.h>
96
97 // service definitions
98 #define SERVICE_DLL   "advapi32.dll"
99 typedef SC_HANDLE (WINAPI *FP_OpenSCManagerA)(char *, char *, DWORD);
100 typedef SC_HANDLE (WINAPI *FP_OpenServiceA)(SC_HANDLE, char *, DWORD);
101 typedef BOOL (WINAPI *FP_QueryServiceStatus)(SC_HANDLE, LPSERVICE_STATUS);
102 typedef BOOL (WINAPI *FP_CloseServiceHandle)(SC_HANDLE);
103
104 #define KRB5_DEFAULT_LIFE            60*60*10 /* 10 hours */
105 #define LSA_CCNAME                   "MSLSA:"
106
107 #define KTC_ERROR      11862784L
108 #define KTC_TOOBIG     11862785L
109 #define KTC_INVAL      11862786L
110 #define KTC_NOENT      11862787L
111 #define KTC_PIOCTLFAIL 11862788L
112 #define KTC_NOPIOCTL   11862789L
113 #define KTC_NOCELL     11862790L
114 #define KTC_NOCM       11862791L
115
116 /* User Query data structures and functions */
117
118 struct textField {
119     char * buf;                       /* Destination buffer address */
120     int    len;                       /* Destination buffer length */
121     char * label;                     /* Label for this field */
122     char * def;                       /* Default response for this field */
123     int    echo;                      /* 0 = no, 1 = yes, 2 = asterisks */
124 };
125
126 #define ID_TEXT       150
127 #define ID_MID_TEXT   300
128
129 struct principal_ccache_data {
130     struct principal_ccache_data * next;
131     char * principal;
132     char * ccache_name;
133     int    from_lsa;
134     int    expired;
135     int    expiration_time;
136     int    renew;
137 };
138
139 struct cell_principal_map {
140     struct cell_principal_map * next;
141     char * cell;
142     char * principal;
143     int    active;
144 };
145
146 /* In order to avoid including the private CCAPI headers */
147 typedef int cc_int32;
148
149 #define CC_API_VER_1 1
150 #define CC_API_VER_2 2
151
152 #define CCACHE_API cc_int32
153
154 /*
155 ** The Official Error Codes
156 */
157 #define CC_NOERROR           0
158 #define CC_BADNAME           1
159 #define CC_NOTFOUND          2
160 #define CC_END               3
161 #define CC_IO                4
162 #define CC_WRITE             5
163 #define CC_NOMEM             6
164 #define CC_FORMAT            7
165 #define CC_LOCKED            8
166 #define CC_BAD_API_VERSION   9
167 #define CC_NO_EXIST          10
168 #define CC_NOT_SUPP          11
169 #define CC_BAD_PARM          12
170 #define CC_ERR_CACHE_ATTACH  13
171 #define CC_ERR_CACHE_RELEASE 14
172 #define CC_ERR_CACHE_FULL    15
173 #define CC_ERR_CRED_VERSION  16
174
175 enum {
176     CC_CRED_VUNKNOWN = 0,       // For validation
177     CC_CRED_V4 = 1,
178     CC_CRED_V5 = 2,
179     CC_CRED_VMAX = 3            // For validation
180 };
181
182 typedef struct opaque_dll_control_block_type* apiCB;
183 typedef struct _infoNC {
184     char*     name;
185     char*     principal;
186     cc_int32  vers;
187 } infoNC;
188
189 TYPEDEF_FUNC(
190 CCACHE_API,
191 CALLCONV_C,
192 cc_initialize,
193     (
194     apiCB** cc_ctx,           // <  DLL's primary control structure.
195                               //    returned here, passed everywhere else
196     cc_int32 api_version,     // >  ver supported by caller (use CC_API_VER_1)
197     cc_int32*  api_supported, // <  if ~NULL, max ver supported by DLL
198     const char** vendor       // <  if ~NULL, vendor name in read only C string
199     )
200 );
201
202 TYPEDEF_FUNC(
203 CCACHE_API,
204 CALLCONV_C,
205 cc_shutdown,
206     (
207     apiCB** cc_ctx            // <> DLL's primary control structure. NULL after
208     )
209 );
210
211 TYPEDEF_FUNC(
212 CCACHE_API,
213 CALLCONV_C,
214 cc_get_NC_info,
215     (
216     apiCB* cc_ctx,          // >  DLL's primary control structure
217     struct _infoNC*** ppNCi // <  (NULL before call) null terminated,
218                             //    list of a structs (free via cc_free_infoNC())
219     )
220 );
221
222 TYPEDEF_FUNC(
223 CCACHE_API,
224 CALLCONV_C,
225 cc_free_NC_info,
226     (
227     apiCB* cc_ctx,
228     struct _infoNC*** ppNCi // <  free list of structs returned by
229                             //    cc_get_cache_names().  set to NULL on return
230     )
231 );
232 #define CCAPI_DLL   "krbcc32.dll"
233
234 /* Function Prototypes */
235 DWORD GetServiceStatus(LPSTR, LPSTR, DWORD *);
236 void KFW_AFS_error(LONG, LPCSTR);
237
238 void UnloadFuncs(FUNC_INFO [], HINSTANCE);
239 int  LoadFuncs(const char*, FUNC_INFO [], HINSTANCE*, int*, int, int, int);
240 int  KFW_get_ccache(krb5_context, krb5_principal, krb5_ccache *);
241 int  KFW_error(krb5_error_code, LPCSTR, int, krb5_context *, krb5_ccache *);
242 int  KFW_kinit(krb5_context, krb5_ccache, HWND, char *, char *, krb5_deltat,
243                 DWORD, DWORD, krb5_deltat, DWORD, DWORD);
244 int  KFW_renew(krb5_context, krb5_ccache);
245 int  KFW_destroy(krb5_context, krb5_ccache);
246 BOOL KFW_ms2mit(krb5_context, krb5_ccache, BOOL);
247 int  KFW_AFS_unlog(void);
248 int  KFW_AFS_klog(krb5_context, krb5_ccache, char*, char*, char*, int, char*);
249 void KFW_import_ccache_data(void);
250 BOOL MSLSA_IsKerberosLogon();
251 char *afs_realm_of_cell(struct afsconf_cell *);
252 #endif /* AFSKFW_INT_H */