lib/curl_sasl.h

   1 #ifndef HEADER_CURL_SASL_H
   2 #define HEADER_CURL_SASL_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 2012 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at http://curl.haxx.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24
  25 #include "pingpong.h"
  26
  27 /* Authentication mechanism flags */
  28 #define SASL_MECH_LOGIN         (1 << 0)
  29 #define SASL_MECH_PLAIN         (1 << 1)
  30 #define SASL_MECH_CRAM_MD5      (1 << 2)
  31 #define SASL_MECH_DIGEST_MD5    (1 << 3)
  32 #define SASL_MECH_GSSAPI        (1 << 4)
  33 #define SASL_MECH_EXTERNAL      (1 << 5)
  34 #define SASL_MECH_NTLM          (1 << 6)
  35
  36 /* Authentication mechanism values */
  37 #define SASL_AUTH_NONE          0
  38 #define SASL_AUTH_ANY           ~0
  39
  40 /* This is used to generate a base64 encoded PLAIN authentication message */
  41 CURLcode Curl_sasl_create_plain_message(struct SessionHandle *data,
  42                                         const char *userp,
  43                                         const char *passwdp,
  44                                         char **outptr, size_t *outlen);
  45
  46 /* This is used to generate a base64 encoded LOGIN authentication message
  47    containing either the user name or password details */
  48 CURLcode Curl_sasl_create_login_message(struct SessionHandle *data,
  49                                         const char *valuep, char **outptr,
  50                                         size_t *outlen);
  51
  52 #ifndef CURL_DISABLE_CRYPTO_AUTH
  53 /* This is used to generate a base64 encoded CRAM-MD5 response message */
  54 CURLcode Curl_sasl_create_cram_md5_message(struct SessionHandle *data,
  55                                            const char *chlg64,
  56                                            const char *user,
  57                                            const char *passwdp,
  58                                            char **outptr, size_t *outlen);
  59
  60 /* This is used to generate a base64 encoded DIGEST-MD5 response message */
  61 CURLcode Curl_sasl_create_digest_md5_message(struct SessionHandle *data,
  62                                              const char *chlg64,
  63                                              const char *user,
  64                                              const char *passwdp,
  65                                              const char *service,
  66                                              char **outptr, size_t *outlen);
  67 #endif
  68
  69 #ifdef USE_NTLM
  70 /* This is used to generate a base64 encoded NTLM type-1 message */
  71 CURLcode Curl_sasl_create_ntlm_type1_message(const char *userp,
  72                                              const char *passwdp,
  73                                              struct ntlmdata *ntlm,
  74                                              char **outptr,
  75                                              size_t *outlen);
  76
  77 /* This is used to decode an incoming NTLM type-2 message and generate a
  78    base64 encoded type-3 response */
  79 CURLcode Curl_sasl_create_ntlm_type3_message(struct SessionHandle *data,
  80                                              const char *header,
  81                                              const char *userp,
  82                                              const char *passwdp,
  83                                              struct ntlmdata *ntlm,
  84                                              char **outptr, size_t *outlen);
  85
  86 #endif /* USE_NTLM */
  87
  88 /* This is used to cleanup any libraries or curl modules used by the sasl
  89    functions */
  90 void Curl_sasl_cleanup(struct connectdata *conn, unsigned int authused);
  91
  92 #endif /* HEADER_CURL_SASL_H */