curl_sasl.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. #ifndef HEADER_CURL_SASL_H
  2. #define HEADER_CURL_SASL_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 2012 - 2022, 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 https://curl.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. #include <curl/curl.h>
  25. #include "bufref.h"
  26. struct Curl_easy;
  27. struct connectdata;
  28. /* Authentication mechanism flags */
  29. #define SASL_MECH_LOGIN (1 << 0)
  30. #define SASL_MECH_PLAIN (1 << 1)
  31. #define SASL_MECH_CRAM_MD5 (1 << 2)
  32. #define SASL_MECH_DIGEST_MD5 (1 << 3)
  33. #define SASL_MECH_GSSAPI (1 << 4)
  34. #define SASL_MECH_EXTERNAL (1 << 5)
  35. #define SASL_MECH_NTLM (1 << 6)
  36. #define SASL_MECH_XOAUTH2 (1 << 7)
  37. #define SASL_MECH_OAUTHBEARER (1 << 8)
  38. #define SASL_MECH_SCRAM_SHA_1 (1 << 9)
  39. #define SASL_MECH_SCRAM_SHA_256 (1 << 10)
  40. /* Authentication mechanism values */
  41. #define SASL_AUTH_NONE 0
  42. #define SASL_AUTH_ANY 0xffff
  43. #define SASL_AUTH_DEFAULT (SASL_AUTH_ANY & ~SASL_MECH_EXTERNAL)
  44. /* Authentication mechanism strings */
  45. #define SASL_MECH_STRING_LOGIN "LOGIN"
  46. #define SASL_MECH_STRING_PLAIN "PLAIN"
  47. #define SASL_MECH_STRING_CRAM_MD5 "CRAM-MD5"
  48. #define SASL_MECH_STRING_DIGEST_MD5 "DIGEST-MD5"
  49. #define SASL_MECH_STRING_GSSAPI "GSSAPI"
  50. #define SASL_MECH_STRING_EXTERNAL "EXTERNAL"
  51. #define SASL_MECH_STRING_NTLM "NTLM"
  52. #define SASL_MECH_STRING_XOAUTH2 "XOAUTH2"
  53. #define SASL_MECH_STRING_OAUTHBEARER "OAUTHBEARER"
  54. #define SASL_MECH_STRING_SCRAM_SHA_1 "SCRAM-SHA-1"
  55. #define SASL_MECH_STRING_SCRAM_SHA_256 "SCRAM-SHA-256"
  56. /* SASL flags */
  57. #define SASL_FLAG_BASE64 0x0001 /* Messages are base64-encoded */
  58. /* SASL machine states */
  59. typedef enum {
  60. SASL_STOP,
  61. SASL_PLAIN,
  62. SASL_LOGIN,
  63. SASL_LOGIN_PASSWD,
  64. SASL_EXTERNAL,
  65. SASL_CRAMMD5,
  66. SASL_DIGESTMD5,
  67. SASL_DIGESTMD5_RESP,
  68. SASL_NTLM,
  69. SASL_NTLM_TYPE2MSG,
  70. SASL_GSSAPI,
  71. SASL_GSSAPI_TOKEN,
  72. SASL_GSSAPI_NO_DATA,
  73. SASL_OAUTH2,
  74. SASL_OAUTH2_RESP,
  75. SASL_GSASL,
  76. SASL_CANCEL,
  77. SASL_FINAL
  78. } saslstate;
  79. /* Progress indicator */
  80. typedef enum {
  81. SASL_IDLE,
  82. SASL_INPROGRESS,
  83. SASL_DONE
  84. } saslprogress;
  85. /* Protocol dependent SASL parameters */
  86. struct SASLproto {
  87. const char *service; /* The service name */
  88. CURLcode (*sendauth)(struct Curl_easy *data, const char *mech,
  89. const struct bufref *ir);
  90. /* Send authentication command */
  91. CURLcode (*contauth)(struct Curl_easy *data, const char *mech,
  92. const struct bufref *contauth);
  93. /* Send authentication continuation */
  94. CURLcode (*cancelauth)(struct Curl_easy *data, const char *mech);
  95. /* Cancel authentication. */
  96. CURLcode (*getmessage)(struct Curl_easy *data, struct bufref *out);
  97. /* Get SASL response message */
  98. size_t maxirlen; /* Maximum initial response + mechanism length,
  99. or zero if no max. This is normally the max
  100. command length - other characters count.
  101. This has to be zero for non-base64 protocols. */
  102. int contcode; /* Code to receive when continuation is expected */
  103. int finalcode; /* Code to receive upon authentication success */
  104. unsigned short defmechs; /* Mechanisms enabled by default */
  105. unsigned short flags; /* Configuration flags. */
  106. };
  107. /* Per-connection parameters */
  108. struct SASL {
  109. const struct SASLproto *params; /* Protocol dependent parameters */
  110. saslstate state; /* Current machine state */
  111. const char *curmech; /* Current mechanism id. */
  112. unsigned short authmechs; /* Accepted authentication mechanisms */
  113. unsigned short prefmech; /* Preferred authentication mechanism */
  114. unsigned short authused; /* Auth mechanism used for the connection */
  115. bool resetprefs; /* For URL auth option parsing. */
  116. bool mutual_auth; /* Mutual authentication enabled (GSSAPI only) */
  117. bool force_ir; /* Protocol always supports initial response */
  118. };
  119. /* This is used to test whether the line starts with the given mechanism */
  120. #define sasl_mech_equal(line, wordlen, mech) \
  121. (wordlen == (sizeof(mech) - 1) / sizeof(char) && \
  122. !memcmp(line, mech, wordlen))
  123. /* This is used to cleanup any libraries or curl modules used by the sasl
  124. functions */
  125. void Curl_sasl_cleanup(struct connectdata *conn, unsigned short authused);
  126. /* Convert a mechanism name to a token */
  127. unsigned short Curl_sasl_decode_mech(const char *ptr,
  128. size_t maxlen, size_t *len);
  129. /* Parse the URL login options */
  130. CURLcode Curl_sasl_parse_url_auth_option(struct SASL *sasl,
  131. const char *value, size_t len);
  132. /* Initializes an SASL structure */
  133. void Curl_sasl_init(struct SASL *sasl, struct Curl_easy *data,
  134. const struct SASLproto *params);
  135. /* Check if we have enough auth data and capabilities to authenticate */
  136. bool Curl_sasl_can_authenticate(struct SASL *sasl, struct Curl_easy *data);
  137. /* Calculate the required login details for SASL authentication */
  138. CURLcode Curl_sasl_start(struct SASL *sasl, struct Curl_easy *data,
  139. bool force_ir, saslprogress *progress);
  140. /* Continue an SASL authentication */
  141. CURLcode Curl_sasl_continue(struct SASL *sasl, struct Curl_easy *data,
  142. int code, saslprogress *progress);
  143. #endif /* HEADER_CURL_SASL_H */