Coverage Report

Created: 2025-07-11 06:33

/src/PROJ/curl/lib/http_ntlm.c
Line
Count
Source (jump to first uncovered line)
1
/***************************************************************************
2
 *                                  _   _ ____  _
3
 *  Project                     ___| | | |  _ \| |
4
 *                             / __| | | | |_) | |
5
 *                            | (__| |_| |  _ <| |___
6
 *                             \___|\___/|_| \_\_____|
7
 *
8
 * Copyright (C) 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 https://curl.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
 * SPDX-License-Identifier: curl
22
 *
23
 ***************************************************************************/
24
25
#include "curl_setup.h"
26
27
#if !defined(CURL_DISABLE_HTTP) && defined(USE_NTLM)
28
29
/*
30
 * NTLM details:
31
 *
32
 * https://davenport.sourceforge.net/ntlm.html
33
 * https://www.innovation.ch/java/ntlm.html
34
 */
35
36
#include "urldata.h"
37
#include "sendf.h"
38
#include "strcase.h"
39
#include "http_ntlm.h"
40
#include "curl_ntlm_core.h"
41
#include "curlx/base64.h"
42
#include "vauth/vauth.h"
43
#include "url.h"
44
#include "curlx/strparse.h"
45
46
/* SSL backend-specific #if branches in this file must be kept in the order
47
   documented in curl_ntlm_core. */
48
#if defined(USE_WINDOWS_SSPI)
49
#include "curl_sspi.h"
50
#endif
51
52
/* The last 3 #include files should be in this order */
53
#include "curl_printf.h"
54
#include "curl_memory.h"
55
#include "memdebug.h"
56
57
CURLcode Curl_input_ntlm(struct Curl_easy *data,
58
                         bool proxy,         /* if proxy or not */
59
                         const char *header) /* rest of the www-authenticate:
60
                                                header */
61
0
{
62
  /* point to the correct struct with this */
63
0
  curlntlm *state;
64
0
  CURLcode result = CURLE_OK;
65
0
  struct connectdata *conn = data->conn;
66
67
0
  state = proxy ? &conn->proxy_ntlm_state : &conn->http_ntlm_state;
68
69
0
  if(checkprefix("NTLM", header)) {
70
0
    struct ntlmdata *ntlm = Curl_auth_ntlm_get(conn, proxy);
71
0
    if(!ntlm)
72
0
      return CURLE_FAILED_INIT;
73
74
0
    header += strlen("NTLM");
75
0
    curlx_str_passblanks(&header);
76
0
    if(*header) {
77
0
      unsigned char *hdr;
78
0
      size_t hdrlen;
79
80
0
      result = curlx_base64_decode(header, &hdr, &hdrlen);
81
0
      if(!result) {
82
0
        struct bufref hdrbuf;
83
84
0
        Curl_bufref_init(&hdrbuf);
85
0
        Curl_bufref_set(&hdrbuf, hdr, hdrlen, curl_free);
86
0
        result = Curl_auth_decode_ntlm_type2_message(data, &hdrbuf, ntlm);
87
0
        Curl_bufref_free(&hdrbuf);
88
0
      }
89
0
      if(result)
90
0
        return result;
91
92
0
      *state = NTLMSTATE_TYPE2; /* We got a type-2 message */
93
0
    }
94
0
    else {
95
0
      if(*state == NTLMSTATE_LAST) {
96
0
        infof(data, "NTLM auth restarted");
97
0
        Curl_auth_ntlm_remove(conn, proxy);
98
0
      }
99
0
      else if(*state == NTLMSTATE_TYPE3) {
100
0
        infof(data, "NTLM handshake rejected");
101
0
        Curl_auth_ntlm_remove(conn, proxy);
102
0
        *state = NTLMSTATE_NONE;
103
0
        return CURLE_REMOTE_ACCESS_DENIED;
104
0
      }
105
0
      else if(*state >= NTLMSTATE_TYPE1) {
106
0
        infof(data, "NTLM handshake failure (internal error)");
107
0
        return CURLE_REMOTE_ACCESS_DENIED;
108
0
      }
109
110
0
      *state = NTLMSTATE_TYPE1; /* We should send away a type-1 */
111
0
    }
112
0
  }
113
114
0
  return result;
115
0
}
116
117
/*
118
 * This is for creating NTLM header output
119
 */
120
CURLcode Curl_output_ntlm(struct Curl_easy *data, bool proxy)
121
0
{
122
0
  char *base64 = NULL;
123
0
  size_t len = 0;
124
0
  CURLcode result = CURLE_OK;
125
0
  struct bufref ntlmmsg;
126
127
  /* point to the address of the pointer that holds the string to send to the
128
     server, which is for a plain host or for an HTTP proxy */
129
0
  char **allocuserpwd;
130
131
  /* point to the username, password, service and host */
132
0
  const char *userp;
133
0
  const char *passwdp;
134
0
  const char *service = NULL;
135
0
  const char *hostname = NULL;
136
137
  /* point to the correct struct with this */
138
0
  struct ntlmdata *ntlm;
139
0
  curlntlm *state;
140
0
  struct auth *authp;
141
0
  struct connectdata *conn = data->conn;
142
143
0
  DEBUGASSERT(conn);
144
0
  DEBUGASSERT(data);
145
146
0
  if(proxy) {
147
0
#ifndef CURL_DISABLE_PROXY
148
0
    allocuserpwd = &data->state.aptr.proxyuserpwd;
149
0
    userp = data->state.aptr.proxyuser;
150
0
    passwdp = data->state.aptr.proxypasswd;
151
0
    service = data->set.str[STRING_PROXY_SERVICE_NAME] ?
152
0
      data->set.str[STRING_PROXY_SERVICE_NAME] : "HTTP";
153
0
    hostname = conn->http_proxy.host.name;
154
0
    state = &conn->proxy_ntlm_state;
155
0
    authp = &data->state.authproxy;
156
#else
157
    return CURLE_NOT_BUILT_IN;
158
#endif
159
0
  }
160
0
  else {
161
0
    allocuserpwd = &data->state.aptr.userpwd;
162
0
    userp = data->state.aptr.user;
163
0
    passwdp = data->state.aptr.passwd;
164
0
    service = data->set.str[STRING_SERVICE_NAME] ?
165
0
      data->set.str[STRING_SERVICE_NAME] : "HTTP";
166
0
    hostname = conn->host.name;
167
0
    state = &conn->http_ntlm_state;
168
0
    authp = &data->state.authhost;
169
0
  }
170
0
  ntlm = Curl_auth_ntlm_get(conn, proxy);
171
0
  if(!ntlm)
172
0
    return CURLE_OUT_OF_MEMORY;
173
0
  authp->done = FALSE;
174
175
  /* not set means empty */
176
0
  if(!userp)
177
0
    userp = "";
178
179
0
  if(!passwdp)
180
0
    passwdp = "";
181
182
#ifdef USE_WINDOWS_SSPI
183
  if(!Curl_pSecFn) {
184
    /* not thread safe and leaks - use curl_global_init() to avoid */
185
    CURLcode err = Curl_sspi_global_init();
186
    if(!Curl_pSecFn)
187
      return err;
188
  }
189
#ifdef SECPKG_ATTR_ENDPOINT_BINDINGS
190
  ntlm->sslContext = conn->sslContext;
191
#endif
192
#endif
193
194
0
  Curl_bufref_init(&ntlmmsg);
195
196
  /* connection is already authenticated, do not send a header in future
197
   * requests so go directly to NTLMSTATE_LAST */
198
0
  if(*state == NTLMSTATE_TYPE3)
199
0
    *state = NTLMSTATE_LAST;
200
201
0
  switch(*state) {
202
0
  case NTLMSTATE_TYPE1:
203
0
  default: /* for the weird cases we (re)start here */
204
    /* Create a type-1 message */
205
0
    result = Curl_auth_create_ntlm_type1_message(data, userp, passwdp, service,
206
0
                                                 hostname, ntlm, &ntlmmsg);
207
0
    if(!result) {
208
0
      DEBUGASSERT(Curl_bufref_len(&ntlmmsg) != 0);
209
0
      result = curlx_base64_encode((const char *) Curl_bufref_ptr(&ntlmmsg),
210
0
                                  Curl_bufref_len(&ntlmmsg), &base64, &len);
211
0
      if(!result) {
212
0
        free(*allocuserpwd);
213
0
        *allocuserpwd = aprintf("%sAuthorization: NTLM %s\r\n",
214
0
                                proxy ? "Proxy-" : "",
215
0
                                base64);
216
0
        free(base64);
217
0
        if(!*allocuserpwd)
218
0
          result = CURLE_OUT_OF_MEMORY;
219
0
      }
220
0
    }
221
0
    break;
222
223
0
  case NTLMSTATE_TYPE2:
224
    /* We already received the type-2 message, create a type-3 message */
225
0
    result = Curl_auth_create_ntlm_type3_message(data, userp, passwdp,
226
0
                                                 ntlm, &ntlmmsg);
227
0
    if(!result && Curl_bufref_len(&ntlmmsg)) {
228
0
      result = curlx_base64_encode((const char *) Curl_bufref_ptr(&ntlmmsg),
229
0
                                   Curl_bufref_len(&ntlmmsg), &base64, &len);
230
0
      if(!result) {
231
0
        free(*allocuserpwd);
232
0
        *allocuserpwd = aprintf("%sAuthorization: NTLM %s\r\n",
233
0
                                proxy ? "Proxy-" : "",
234
0
                                base64);
235
0
        free(base64);
236
0
        if(!*allocuserpwd)
237
0
          result = CURLE_OUT_OF_MEMORY;
238
0
        else {
239
0
          *state = NTLMSTATE_TYPE3; /* we send a type-3 */
240
0
          authp->done = TRUE;
241
0
        }
242
0
      }
243
0
    }
244
0
    break;
245
246
0
  case NTLMSTATE_LAST:
247
    /* since this is a little artificial in that this is used without any
248
       outgoing auth headers being set, we need to set the bit by force */
249
0
    if(proxy)
250
0
      data->info.proxyauthpicked = CURLAUTH_NTLM;
251
0
    else
252
0
      data->info.httpauthpicked = CURLAUTH_NTLM;
253
0
    Curl_safefree(*allocuserpwd);
254
0
    authp->done = TRUE;
255
0
    break;
256
0
  }
257
0
  Curl_bufref_free(&ntlmmsg);
258
259
0
  return result;
260
0
}
261
262
#endif /* !CURL_DISABLE_HTTP && USE_NTLM */