d915710f8b7913f005105f79ad0dfe6793c87840
[platform/upstream/curl.git] / lib / curl_sspi.c
1 /***************************************************************************
2  *                                  _   _ ____  _
3  *  Project                     ___| | | |  _ \| |
4  *                             / __| | | | |_) | |
5  *                            | (__| |_| |  _ <| |___
6  *                             \___|\___/|_| \_\_____|
7  *
8  * Copyright (C) 1998 - 2009, Daniel Stenberg, <daniel@haxx.se>, et al.
9  *
10  * This software is licensed as described in the file COPYING, which
11  * you should have received as part of this distribution. The terms
12  * are also available at http://curl.haxx.se/docs/copyright.html.
13  *
14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15  * copies of the Software, and permit persons to whom the Software is
16  * furnished to do so, under the terms of the COPYING file.
17  *
18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19  * KIND, either express or implied.
20  *
21  ***************************************************************************/
22
23 #include "setup.h"
24
25 #ifdef USE_WINDOWS_SSPI
26
27 #include <curl/curl.h>
28
29 #include "curl_sspi.h"
30
31 #define _MPRINTF_REPLACE /* use our functions only */
32 #include <curl/mprintf.h>
33
34 #include "curl_memory.h"
35 /* The last #include file should be: */
36 #include "memdebug.h"
37
38
39 /* We use our own typedef here since some headers might lack these */
40 typedef PSecurityFunctionTableA (APIENTRY *INITSECURITYINTERFACE_FN_A)(VOID);
41
42 /* Handle of security.dll or secur32.dll, depending on Windows version */
43 HMODULE s_hSecDll = NULL;
44
45 /* Pointer to SSPI dispatch table */
46 PSecurityFunctionTableA s_pSecFn = NULL;
47
48
49 /*
50  * Curl_sspi_global_init()
51  *
52  * This is used to load the Security Service Provider Interface (SSPI)
53  * dynamic link library portably across all Windows versions, without
54  * the need to directly link libcurl, nor the application using it, at
55  * build time.
56  *
57  * Once this function has been executed, Windows SSPI functions can be
58  * called through the Security Service Provider Interface dispatch table.
59  */
60
61 CURLcode
62 Curl_sspi_global_init(void)
63 {
64   OSVERSIONINFO osver;
65   INITSECURITYINTERFACE_FN_A pInitSecurityInterface;
66
67   /* If security interface is not yet initialized try to do this */
68   if(s_hSecDll == NULL) {
69
70     /* Find out Windows version */
71     memset(&osver, 0, sizeof(osver));
72     osver.dwOSVersionInfoSize = sizeof(osver);
73     if(! GetVersionEx(&osver))
74       return CURLE_FAILED_INIT;
75
76     /* Security Service Provider Interface (SSPI) functions are located in
77      * security.dll on WinNT 4.0 and in secur32.dll on Win9x. Win2K and XP
78      * have both these DLLs (security.dll forwards calls to secur32.dll) */
79
80     /* Load SSPI dll into the address space of the calling process */
81     if(osver.dwPlatformId == VER_PLATFORM_WIN32_NT
82       && osver.dwMajorVersion == 4)
83       s_hSecDll = LoadLibrary("security.dll");
84     else
85       s_hSecDll = LoadLibrary("secur32.dll");
86     if(! s_hSecDll)
87       return CURLE_FAILED_INIT;
88
89     /* Get address of the InitSecurityInterfaceA function from the SSPI dll */
90     pInitSecurityInterface = (INITSECURITYINTERFACE_FN_A)
91       GetProcAddress(s_hSecDll, "InitSecurityInterfaceA");
92     if(! pInitSecurityInterface)
93       return CURLE_FAILED_INIT;
94
95     /* Get pointer to Security Service Provider Interface dispatch table */
96     s_pSecFn = pInitSecurityInterface();
97     if(! s_pSecFn)
98       return CURLE_FAILED_INIT;
99
100   }
101   return CURLE_OK;
102 }
103
104
105 /*
106  * Curl_sspi_global_cleanup()
107  *
108  * This deinitializes the Security Service Provider Interface from libcurl.
109  */
110
111 void
112 Curl_sspi_global_cleanup(void)
113 {
114   if(s_hSecDll) {
115     FreeLibrary(s_hSecDll);
116     s_hSecDll = NULL;
117     s_pSecFn = NULL;
118   }
119 }
120
121
122 /*
123  * Curl_sspi_status(SECURIY_STATUS status)
124  *
125  * This function returns a string representing an SSPI status.
126  * It will in any case return a usable string pointer which needs to be freed.
127  */
128 char*
129 Curl_sspi_status(SECURITY_STATUS status)
130 {
131   const char* status_const;
132
133   switch(status) {
134     case SEC_I_COMPLETE_AND_CONTINUE:
135       status_const = "SEC_I_COMPLETE_AND_CONTINUE";
136       break;
137     case SEC_I_COMPLETE_NEEDED:
138       status_const = "SEC_I_COMPLETE_NEEDED";
139       break;
140     case SEC_I_CONTINUE_NEEDED:
141       status_const = "SEC_I_CONTINUE_NEEDED";
142       break;
143     case SEC_I_CONTEXT_EXPIRED:
144       status_const = "SEC_I_CONTEXT_EXPIRED";
145       break;
146     case SEC_I_INCOMPLETE_CREDENTIALS:
147       status_const = "SEC_I_INCOMPLETE_CREDENTIALS";
148       break;
149     case SEC_I_RENEGOTIATE:
150       status_const = "SEC_I_RENEGOTIATE";
151       break;
152     case SEC_E_BUFFER_TOO_SMALL:
153       status_const = "SEC_E_BUFFER_TOO_SMALL";
154       break;
155     case SEC_E_CONTEXT_EXPIRED:
156       status_const = "SEC_E_CONTEXT_EXPIRED";
157       break;
158     case SEC_E_CRYPTO_SYSTEM_INVALID:
159       status_const = "SEC_E_CRYPTO_SYSTEM_INVALID";
160       break;
161     case SEC_E_INCOMPLETE_MESSAGE:
162       status_const = "SEC_E_INCOMPLETE_MESSAGE";
163       break;
164     case SEC_E_INSUFFICIENT_MEMORY:
165       status_const = "SEC_E_INSUFFICIENT_MEMORY";
166       break;
167     case SEC_E_INTERNAL_ERROR:
168       status_const = "SEC_E_INTERNAL_ERROR";
169       break;
170     case SEC_E_INVALID_HANDLE:
171       status_const = "SEC_E_INVALID_HANDLE";
172       break;
173     case SEC_E_INVALID_TOKEN:
174       status_const = "SEC_E_INVALID_TOKEN";
175       break;
176     case SEC_E_LOGON_DENIED:
177       status_const = "SEC_E_LOGON_DENIED";
178       break;
179     case SEC_E_MESSAGE_ALTERED:
180       status_const = "SEC_E_MESSAGE_ALTERED";
181       break;
182     case SEC_E_NO_AUTHENTICATING_AUTHORITY:
183       status_const = "SEC_E_NO_AUTHENTICATING_AUTHORITY";
184       break;
185     case SEC_E_NO_CREDENTIALS:
186       status_const = "SEC_E_NO_CREDENTIALS";
187       break;
188     case SEC_E_NOT_OWNER:
189       status_const = "SEC_E_NOT_OWNER";
190       break;
191     case SEC_E_OK:
192       status_const = "SEC_E_OK";
193       break;
194     case SEC_E_OUT_OF_SEQUENCE:
195       status_const = "SEC_E_OUT_OF_SEQUENCE";
196       break;
197     case SEC_E_QOP_NOT_SUPPORTED:
198       status_const = "SEC_E_QOP_NOT_SUPPORTED";
199       break;
200     case SEC_E_SECPKG_NOT_FOUND:
201       status_const = "SEC_E_SECPKG_NOT_FOUND";
202       break;
203     case SEC_E_TARGET_UNKNOWN:
204       status_const = "SEC_E_TARGET_UNKNOWN";
205       break;
206     case SEC_E_UNKNOWN_CREDENTIALS:
207       status_const = "SEC_E_UNKNOWN_CREDENTIALS";
208       break;
209     case SEC_E_UNSUPPORTED_FUNCTION:
210       status_const = "SEC_E_UNSUPPORTED_FUNCTION";
211       break;
212     case SEC_E_WRONG_PRINCIPAL:
213       status_const = "SEC_E_WRONG_PRINCIPAL";
214       break;
215     default:
216       status_const = "Unknown error";
217   }
218
219   return curl_maprintf("%s (0x%08X)", status_const, status);
220 }
221
222 /*
223  * Curl_sspi_status_msg(SECURITY_STATUS status)
224  *
225  * This function returns a message representing an SSPI status.
226  * It will in any case return a usable string pointer which needs to be freed.
227  */
228
229 char*
230 Curl_sspi_status_msg(SECURITY_STATUS status)
231 {
232   LPSTR format_msg = NULL;
233   char *status_msg = NULL, *status_const = NULL;
234   int status_len = 0;
235
236   status_len = FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
237                              FORMAT_MESSAGE_FROM_SYSTEM |
238                              FORMAT_MESSAGE_IGNORE_INSERTS,
239                              NULL, status, 0, (LPTSTR)&format_msg, 0, NULL);
240
241   if(status_len > 0 && format_msg) {
242     status_msg = strdup(format_msg);
243     LocalFree(format_msg);
244
245     /* remove trailing CR+LF */
246     if(status_len > 0) {
247       if(status_msg[status_len-1] == '\n') {
248         status_msg[status_len-1] = '\0';
249         if(status_len > 1) {
250           if(status_msg[status_len-2] == '\r') {
251             status_msg[status_len-2] = '\0';
252           }
253         }
254       }
255     }
256   }
257
258   status_const = Curl_sspi_status(status);
259   if(status_msg) {
260     status_msg = curl_maprintf("%s [%s]", status_msg, status_const);
261     free(status_const);
262   }
263   else {
264     status_msg = status_const;
265   }
266
267   return status_msg;
268 }
269
270 #endif /* USE_WINDOWS_SSPI */