2 * Copyright (c) 2010 PADL Software Pty Ltd.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * 3. Redistributions in any form must be accompanied by information on
17 * how to obtain complete source code for the GS2 software and any
18 * accompanying software that uses the GS2 software. The source code
19 * must either be included in the distribution or be available for no
20 * more than the cost of distribution plus a nominal fee, and must be
21 * freely redistributable under reasonable conditions. For an
22 * executable file, complete source code means the source code for all
23 * modules it contains. It does not include source code for modules or
24 * files that typically accompany the major components of the operating
25 * system on which the executable file runs.
27 * THIS SOFTWARE IS PROVIDED BY PADL SOFTWARE ``AS IS'' AND ANY EXPRESS
28 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
30 * NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL PADL SOFTWARE
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
37 * THE POSSIBILITY OF SUCH DAMAGE.
40 * Copyright (c) 1998-2003 Carnegie Mellon University.
41 * All rights reserved.
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
50 * 2. Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in
52 * the documentation and/or other materials provided with the
55 * 3. The name "Carnegie Mellon University" must not be used to
56 * endorse or promote products derived from this software without
57 * prior written permission. For permission or any other legal
58 * details, please contact
59 * Office of Technology Transfer
60 * Carnegie Mellon University
62 * Pittsburgh, PA 15213-3890
63 * (412) 268-4387, fax: (412) 268-7395
64 * tech-transfer@andrew.cmu.edu
66 * 4. Redistributions of any form whatsoever must retain the following
68 * "This product includes software developed by Computing Services
69 * at Carnegie Mellon University (http://www.cmu.edu/computing/)."
71 * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
72 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
73 * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
74 * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
75 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
76 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
77 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
81 #include <gssapi/gssapi.h>
82 #include <gssapi/gssapi_ext.h>
89 #include "plugin_common.h"
97 #include "gs2_token.h"
99 #define GS2_CB_FLAG_MASK 0x0F
100 #define GS2_CB_FLAG_N 0x00
101 #define GS2_CB_FLAG_P 0x01
102 #define GS2_CB_FLAG_Y 0x02
103 #define GS2_NONSTD_FLAG 0x10
105 typedef struct context {
106 gss_ctx_id_t gss_ctx;
107 gss_name_t client_name;
108 gss_name_t server_name;
109 gss_cred_id_t server_creds;
110 gss_cred_id_t client_creds;
112 unsigned out_buf_len;
113 const sasl_utils_t *utils;
117 sasl_client_plug_t *client;
118 sasl_server_plug_t *server;
123 struct gss_channel_bindings_struct gss_cbindings;
124 sasl_secret_t *password;
125 unsigned int free_password;
129 static gss_OID_set gs2_mechs = GSS_C_NO_OID_SET;
131 static int gs2_ask_user_info(context_t *context,
132 sasl_client_params_t *params,
133 char **realms, int nrealm,
134 sasl_interact_t **prompt_need,
135 sasl_out_params_t *oparams);
137 static int gs2_verify_initial_message(context_t *text,
138 sasl_server_params_t *sparams,
143 static int gs2_make_header(context_t *text,
144 sasl_client_params_t *cparams,
149 static int gs2_make_message(context_t *text,
150 sasl_client_params_t *cparams,
151 int initialContextToken,
156 static int gs2_get_mech_attrs(const sasl_utils_t *utils,
158 unsigned int *security_flags,
159 unsigned int *features,
160 const unsigned long **prompts);
162 static int gs2_indicate_mechs(const sasl_utils_t *utils);
164 static int gs2_map_sasl_name(const sasl_utils_t *utils,
168 static int gs2_duplicate_buffer(const sasl_utils_t *utils,
169 const gss_buffer_t src,
172 static int gs2_unescape_authzid(const sasl_utils_t *utils,
177 static int gs2_escape_authzid(const sasl_utils_t *utils,
182 /* sasl_gs_log: only logs status string returned from gss_display_status() */
183 #define sasl_gs2_log(x,y,z) sasl_gs2_seterror_(x,y,z,1)
184 #define sasl_gs2_seterror(x,y,z) sasl_gs2_seterror_(x,y,z,0)
187 sasl_gs2_seterror_(const sasl_utils_t *utils, OM_uint32 maj, OM_uint32 min,
191 sasl_gs2_new_context(const sasl_utils_t *utils)
195 ret = utils->malloc(sizeof(context_t));
199 memset(ret, 0, sizeof(context_t));
206 sasl_gs2_free_context_contents(context_t *text)
213 if (text->gss_ctx != GSS_C_NO_CONTEXT) {
214 gss_delete_sec_context(&min_stat,&text->gss_ctx,
216 text->gss_ctx = GSS_C_NO_CONTEXT;
219 if (text->client_name != GSS_C_NO_NAME) {
220 gss_release_name(&min_stat,&text->client_name);
221 text->client_name = GSS_C_NO_NAME;
224 if (text->server_name != GSS_C_NO_NAME) {
225 gss_release_name(&min_stat,&text->server_name);
226 text->server_name = GSS_C_NO_NAME;
229 if (text->server_creds != GSS_C_NO_CREDENTIAL) {
230 gss_release_cred(&min_stat, &text->server_creds);
231 text->server_creds = GSS_C_NO_CREDENTIAL;
234 if (text->client_creds != GSS_C_NO_CREDENTIAL) {
235 gss_release_cred(&min_stat, &text->client_creds);
236 text->client_creds = GSS_C_NO_CREDENTIAL;
239 if (text->authid != NULL) {
240 text->utils->free(text->authid);
244 if (text->authzid != NULL) {
245 text->utils->free(text->authzid);
246 text->authzid = NULL;
249 gss_release_buffer(&min_stat, &text->gss_cbindings.application_data);
251 if (text->out_buf != NULL) {
252 text->utils->free(text->out_buf);
253 text->out_buf = NULL;
256 text->out_buf_len = 0;
258 if (text->cbindingname != NULL) {
259 text->utils->free(text->cbindingname);
260 text->cbindingname = NULL;
263 if (text->free_password)
264 _plug_free_secret(text->utils, &text->password);
266 memset(text, 0, sizeof(*text));
272 gs2_common_mech_dispose(void *conn_context, const sasl_utils_t *utils)
274 sasl_gs2_free_context_contents((context_t *)(conn_context));
275 utils->free(conn_context);
279 gs2_common_mech_free(void *global_context __attribute__((unused)),
280 const sasl_utils_t *utils)
284 if (gs2_mechs != GSS_C_NO_OID_SET) {
285 gss_release_oid_set(&minor, &gs2_mechs);
286 gs2_mechs = GSS_C_NO_OID_SET;
290 /***************************** Server Section *****************************/
293 gs2_server_mech_new(void *glob_context,
294 sasl_server_params_t *params,
295 const char *challenge __attribute__((unused)),
296 unsigned challen __attribute__((unused)),
302 text = sasl_gs2_new_context(params->utils);
304 MEMERROR(params->utils);
308 text->gss_ctx = GSS_C_NO_CONTEXT;
309 text->client_name = GSS_C_NO_NAME;
310 text->server_name = GSS_C_NO_NAME;
311 text->server_creds = GSS_C_NO_CREDENTIAL;
312 text->client_creds = GSS_C_NO_CREDENTIAL;
313 text->plug.server = glob_context;
315 ret = gs2_map_sasl_name(params->utils, text->plug.server->mech_name,
317 if (ret != SASL_OK) {
318 gs2_common_mech_dispose(text, params->utils);
322 *conn_context = text;
328 gs2_server_mech_step(void *conn_context,
329 sasl_server_params_t *params,
330 const char *clientin,
331 unsigned clientinlen,
332 const char **serverout,
333 unsigned *serveroutlen,
334 sasl_out_params_t *oparams)
336 context_t *text = (context_t *)conn_context;
337 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
338 gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
339 OM_uint32 maj_stat = GSS_S_FAILURE, min_stat = 0;
340 gss_buffer_desc name_buf = GSS_C_EMPTY_BUFFER;
341 gss_buffer_desc short_name_buf = GSS_C_EMPTY_BUFFER;
342 gss_name_t without = GSS_C_NO_NAME;
343 gss_OID_set_desc mechs;
344 gss_OID actual_mech = GSS_C_NO_OID;
345 OM_uint32 out_flags = 0;
346 int ret = 0, equal = 0;
347 int initialContextToken = (text->gss_ctx == GSS_C_NO_CONTEXT);
350 if (serverout == NULL) {
351 PARAMERROR(text->utils);
352 return SASL_BADPARAM;
358 if (initialContextToken) {
359 name_buf.length = strlen(params->service) + 1 + strlen(params->serverFQDN);
360 name_buf.value = params->utils->malloc(name_buf.length + 1);
361 if (name_buf.value == NULL) {
362 MEMERROR(text->utils);
366 snprintf(name_buf.value, name_buf.length + 1,
367 "%s@%s", params->service, params->serverFQDN);
368 maj_stat = gss_import_name(&min_stat,
370 GSS_C_NT_HOSTBASED_SERVICE,
372 params->utils->free(name_buf.value);
373 name_buf.value = NULL;
375 if (GSS_ERROR(maj_stat))
378 assert(text->server_creds == GSS_C_NO_CREDENTIAL);
381 mechs.elements = (gss_OID)text->mechanism;
383 if (params->gss_creds == GSS_C_NO_CREDENTIAL) {
384 maj_stat = gss_acquire_cred(&min_stat,
392 if (GSS_ERROR(maj_stat))
396 ret = gs2_verify_initial_message(text,
404 input_token.value = (void *)clientin;
405 input_token.length = clientinlen;
408 maj_stat = gss_accept_sec_context(&min_stat,
410 (params->gss_creds != GSS_C_NO_CREDENTIAL)
411 ? (gss_cred_id_t)params->gss_creds
412 : text->server_creds,
414 &text->gss_cbindings,
420 &text->client_creds);
421 if (GSS_ERROR(maj_stat)) {
422 sasl_gs2_log(text->utils, maj_stat, min_stat);
423 text->utils->seterror(text->utils->conn, SASL_NOLOG,
424 "GS2 Failure: gss_accept_sec_context");
425 ret = (maj_stat == GSS_S_BAD_BINDINGS) ? SASL_BADBINDING : SASL_BADAUTH;
429 *serveroutlen = output_token.length;
430 if (output_token.value != NULL) {
431 ret = _plug_buf_alloc(text->utils, &text->out_buf,
432 &text->out_buf_len, *serveroutlen);
435 memcpy(text->out_buf, output_token.value, *serveroutlen);
436 *serverout = text->out_buf;
438 /* No output token, send an empty string */
443 if (maj_stat == GSS_S_CONTINUE_NEEDED) {
448 assert(maj_stat == GSS_S_COMPLETE);
450 if (!g_OID_equal(text->mechanism, actual_mech)) {
451 ret = SASL_WRONGMECH;
454 if ((out_flags & GSS_C_SEQUENCE_FLAG) == 0) {
459 maj_stat = gss_display_name(&min_stat, text->client_name,
461 if (GSS_ERROR(maj_stat))
464 ret = gs2_duplicate_buffer(params->utils, &name_buf, &short_name_buf);
468 p = (char *)memchr(name_buf.value, '@', name_buf.length);
470 short_name_buf.length = (p - (char *)name_buf.value);
472 maj_stat = gss_import_name(&min_stat,
476 if (GSS_ERROR(maj_stat)) {
481 maj_stat = gss_compare_name(&min_stat, text->client_name,
483 if (GSS_ERROR(maj_stat)) {
489 ((char *)short_name_buf.value)[short_name_buf.length] = '\0';
492 text->authid = (char *)short_name_buf.value;
493 short_name_buf.value = NULL;
494 short_name_buf.length = 0;
496 if (text->authzid != NULL) {
497 ret = params->canon_user(params->utils->conn,
499 SASL_CU_AUTHZID, oparams);
504 ret = params->canon_user(params->utils->conn,
506 text->authzid == NULL
507 ? (SASL_CU_AUTHZID | SASL_CU_AUTHID)
513 switch (text->gs2_flags & GS2_CB_FLAG_MASK) {
515 oparams->cbindingdisp = SASL_CB_DISP_NONE;
518 oparams->cbindingdisp = SASL_CB_DISP_USED;
519 oparams->cbindingname = text->cbindingname;
522 oparams->cbindingdisp = SASL_CB_DISP_WANT;
526 if (text->client_creds != GSS_C_NO_CREDENTIAL)
527 oparams->client_creds = &text->client_creds;
529 oparams->client_creds = NULL;
531 oparams->gss_peer_name = text->client_name;
532 oparams->gss_local_name = text->server_name;
533 oparams->maxoutbuf = 0xFFFFFF;
534 oparams->encode = NULL;
535 oparams->decode = NULL;
536 oparams->mech_ssf = 0;
537 oparams->doneflag = 1;
542 if (initialContextToken)
543 gss_release_buffer(&min_stat, &input_token);
544 gss_release_buffer(&min_stat, &name_buf);
545 gss_release_buffer(&min_stat, &short_name_buf);
546 gss_release_buffer(&min_stat, &output_token);
547 gss_release_name(&min_stat, &without);
549 if (ret == SASL_OK && maj_stat != GSS_S_COMPLETE) {
550 sasl_gs2_seterror(text->utils, maj_stat, min_stat);
553 if (ret != SASL_OK && ret != SASL_CONTINUE)
554 sasl_gs2_free_context_contents(text);
560 gs2_common_plug_init(const sasl_utils_t *utils,
562 int (*plug_alloc)(const sasl_utils_t *,
569 OM_uint32 major, minor;
576 if (gs2_indicate_mechs(utils) != SASL_OK) {
580 plugs = utils->malloc(2 * gs2_mechs->count * plugsize);
585 memset(plugs, 0, 2 * gs2_mechs->count * plugsize);
587 for (i = 0; i < gs2_mechs->count; i++) {
588 gss_buffer_desc sasl_mech_name = GSS_C_EMPTY_BUFFER;
590 major = gss_inquire_saslname_for_mech(&minor,
591 &gs2_mechs->elements[i],
595 if (GSS_ERROR(major))
598 #define PLUG_AT(index) (void *)((unsigned char *)plugs + (count * plugsize))
600 if (plug_alloc(utils, PLUG_AT(count), &sasl_mech_name,
601 &gs2_mechs->elements[i]) == SASL_OK)
604 gss_release_buffer(&minor, &sasl_mech_name);
619 gs2_server_plug_alloc(const sasl_utils_t *utils,
621 gss_buffer_t sasl_name,
625 sasl_server_plug_t *splug = (sasl_server_plug_t *)plug;
628 memset(splug, 0, sizeof(*splug));
630 ret = gs2_get_mech_attrs(utils, mech,
631 &splug->security_flags,
637 ret = gs2_duplicate_buffer(utils, sasl_name, &buf);
641 splug->mech_name = (char *)buf.value;
642 splug->glob_context = plug;
643 splug->mech_new = gs2_server_mech_new;
644 splug->mech_step = gs2_server_mech_step;
645 splug->mech_dispose = gs2_common_mech_dispose;
646 splug->mech_free = gs2_common_mech_free;
651 static sasl_server_plug_t *gs2_server_plugins;
652 static int gs2_server_plugcount;
655 gs2_server_plug_init(const sasl_utils_t *utils,
658 sasl_server_plug_t **pluglist,
666 if (maxversion < SASL_SERVER_PLUG_VERSION)
669 *outversion = SASL_SERVER_PLUG_VERSION;
671 if (gs2_server_plugins == NULL) {
672 ret = gs2_common_plug_init(utils,
673 sizeof(sasl_server_plug_t),
674 gs2_server_plug_alloc,
675 (void **)&gs2_server_plugins,
676 &gs2_server_plugcount);
681 *pluglist = gs2_server_plugins;
682 *plugcount = gs2_server_plugcount;
687 /***************************** Client Section *****************************/
689 static int gs2_client_mech_step(void *conn_context,
690 sasl_client_params_t *params,
691 const char *serverin,
692 unsigned serverinlen,
693 sasl_interact_t **prompt_need,
694 const char **clientout,
695 unsigned *clientoutlen,
696 sasl_out_params_t *oparams)
698 context_t *text = (context_t *)conn_context;
699 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
700 gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
701 gss_buffer_desc name_buf = GSS_C_EMPTY_BUFFER;
702 OM_uint32 maj_stat = GSS_S_FAILURE, min_stat = 0;
703 OM_uint32 req_flags, ret_flags;
704 gss_OID actual_mech = GSS_C_NO_OID;
706 int initialContextToken;
711 if (text->gss_ctx == GSS_C_NO_CONTEXT) {
712 ret = gs2_ask_user_info(text, params, NULL, 0, prompt_need, oparams);
716 if (params->gss_creds == GSS_C_NO_CREDENTIAL &&
717 text->password != NULL && text->password->len != 0) {
718 gss_buffer_desc password_buf;
719 gss_buffer_desc name_buf;
720 gss_OID_set_desc mechs;
722 name_buf.length = strlen(oparams->authid);
723 name_buf.value = (void *)oparams->authid;
725 password_buf.length = text->password->len;
726 password_buf.value = text->password->data;
729 mechs.elements = (gss_OID)text->mechanism;
731 maj_stat = gss_import_name(&min_stat,
735 if (GSS_ERROR(maj_stat))
738 maj_stat = gss_acquire_cred_with_password(&min_stat,
747 if (GSS_ERROR(maj_stat))
751 initialContextToken = 1;
753 initialContextToken = 0;
755 if (text->server_name == GSS_C_NO_NAME) { /* only once */
756 name_buf.length = strlen(params->service) + 1 + strlen(params->serverFQDN);
757 name_buf.value = params->utils->malloc(name_buf.length + 1);
758 if (name_buf.value == NULL) {
762 if (params->serverFQDN == NULL ||
763 strlen(params->serverFQDN) == 0) {
764 SETERROR(text->utils, "GS2 Failure: no serverFQDN");
769 snprintf(name_buf.value, name_buf.length + 1,
770 "%s@%s", params->service, params->serverFQDN);
772 maj_stat = gss_import_name (&min_stat,
774 GSS_C_NT_HOSTBASED_SERVICE,
776 params->utils->free(name_buf.value);
777 name_buf.value = NULL;
779 if (GSS_ERROR(maj_stat))
783 /* From GSSAPI plugin: apparently this is for some IMAP bug workaround */
784 if (serverinlen == 0 && text->gss_ctx != GSS_C_NO_CONTEXT) {
785 gss_delete_sec_context(&min_stat, &text->gss_ctx, GSS_C_NO_BUFFER);
786 text->gss_ctx = GSS_C_NO_CONTEXT;
789 input_token.value = (void *)serverin;
790 input_token.length = serverinlen;
792 if (initialContextToken) {
793 if ((text->plug.client->features & SASL_FEAT_GSS_FRAMING) == 0)
794 text->gs2_flags |= GS2_NONSTD_FLAG;
796 switch (params->cbindingdisp) {
797 case SASL_CB_DISP_NONE:
798 text->gs2_flags |= GS2_CB_FLAG_N;
800 case SASL_CB_DISP_USED:
801 text->gs2_flags |= GS2_CB_FLAG_P;
803 case SASL_CB_DISP_WANT:
804 text->gs2_flags |= GS2_CB_FLAG_Y;
808 ret = gs2_make_header(text, params,
809 strcmp(oparams->user, oparams->authid) ?
810 (char *) oparams->user : NULL,
811 &text->out_buf, &text->out_buf_len);
816 req_flags = GSS_C_MUTUAL_FLAG | GSS_C_SEQUENCE_FLAG;
818 maj_stat = gss_init_sec_context(&min_stat,
819 (params->gss_creds != GSS_C_NO_CREDENTIAL)
820 ? (gss_cred_id_t)params->gss_creds
821 : text->client_creds,
824 (gss_OID)text->mechanism,
827 &text->gss_cbindings,
828 serverinlen ? &input_token : GSS_C_NO_BUFFER,
833 if (GSS_ERROR(maj_stat))
836 ret = gs2_make_message(text, params, initialContextToken, &output_token,
837 &text->out_buf, &text->out_buf_len);
841 *clientout = text->out_buf;
842 *clientoutlen = text->out_buf_len;
844 if (maj_stat == GSS_S_CONTINUE_NEEDED) {
849 if (text->client_name != GSS_C_NO_NAME)
850 gss_release_name(&min_stat, &text->client_name);
852 maj_stat = gss_inquire_context(&min_stat,
858 &ret_flags, /* flags */
861 if (GSS_ERROR(maj_stat))
864 if (!g_OID_equal(text->mechanism, actual_mech)) {
865 ret = SASL_WRONGMECH;
868 if ((ret_flags & req_flags) != req_flags) {
869 maj_stat = SASL_BADAUTH;
873 maj_stat = gss_display_name(&min_stat,
877 if (GSS_ERROR(maj_stat))
880 oparams->gss_peer_name = text->server_name;
881 oparams->gss_local_name = text->client_name;
882 oparams->encode = NULL;
883 oparams->decode = NULL;
884 oparams->mech_ssf = 0;
885 oparams->maxoutbuf = 0xFFFFFF;
886 oparams->doneflag = 1;
889 gss_release_buffer(&min_stat, &output_token);
890 gss_release_buffer(&min_stat, &name_buf);
892 if (ret == SASL_OK && maj_stat != GSS_S_COMPLETE) {
893 sasl_gs2_seterror(text->utils, maj_stat, min_stat);
896 if (ret != SASL_OK && ret != SASL_CONTINUE)
897 sasl_gs2_free_context_contents(text);
902 static int gs2_client_mech_new(void *glob_context,
903 sasl_client_params_t *params,
909 text = sasl_gs2_new_context(params->utils);
911 MEMERROR(params->utils);
915 text->gss_ctx = GSS_C_NO_CONTEXT;
916 text->client_name = GSS_C_NO_NAME;
917 text->server_creds = GSS_C_NO_CREDENTIAL;
918 text->client_creds = GSS_C_NO_CREDENTIAL;
919 text->plug.client = glob_context;
921 ret = gs2_map_sasl_name(params->utils, text->plug.client->mech_name,
923 if (ret != SASL_OK) {
924 gs2_common_mech_dispose(text, params->utils);
928 *conn_context = text;
934 gs2_client_plug_alloc(const sasl_utils_t *utils,
936 gss_buffer_t sasl_name,
940 sasl_client_plug_t *cplug = (sasl_client_plug_t *)plug;
943 memset(cplug, 0, sizeof(*cplug));
945 ret = gs2_get_mech_attrs(utils, mech,
946 &cplug->security_flags,
948 &cplug->required_prompts);
952 ret = gs2_duplicate_buffer(utils, sasl_name, &buf);
956 cplug->mech_name = (char *)buf.value;
957 cplug->features |= SASL_FEAT_NEEDSERVERFQDN;
958 cplug->glob_context = plug;
959 cplug->mech_new = gs2_client_mech_new;
960 cplug->mech_step = gs2_client_mech_step;
961 cplug->mech_dispose = gs2_common_mech_dispose;
962 cplug->mech_free = gs2_common_mech_free;
967 static sasl_client_plug_t *gs2_client_plugins;
968 static int gs2_client_plugcount;
971 gs2_client_plug_init(const sasl_utils_t *utils,
974 sasl_client_plug_t **pluglist,
982 if (maxversion < SASL_CLIENT_PLUG_VERSION)
985 *outversion = SASL_CLIENT_PLUG_VERSION;
987 if (gs2_client_plugins == NULL) {
988 ret = gs2_common_plug_init(utils,
989 sizeof(sasl_client_plug_t),
990 gs2_client_plug_alloc,
991 (void **)&gs2_client_plugins,
992 &gs2_client_plugcount);
997 *pluglist = gs2_client_plugins;
998 *plugcount = gs2_client_plugcount;
1004 * Copy header and application channel bindings to GSS channel bindings
1005 * structure in context.
1008 gs2_save_cbindings(context_t *text,
1009 gss_buffer_t header,
1010 const sasl_channel_binding_t *cbinding)
1012 gss_buffer_t gss_cbindings = &text->gss_cbindings.application_data;
1016 assert(gss_cbindings->value == NULL);
1019 * The application-data field MUST be set to the gs2-header, excluding
1020 * the initial [gs2-nonstd-flag ","] part, concatenated with, when a
1021 * gs2-cb-flag of "p" is used, the application's channel binding data.
1023 len = header->length;
1024 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1028 if ((text->gs2_flags & GS2_CB_FLAG_MASK) == GS2_CB_FLAG_P &&
1030 len += cbinding->len;
1033 gss_cbindings->length = len;
1034 gss_cbindings->value = text->utils->malloc(len);
1035 if (gss_cbindings->value == NULL)
1038 p = (unsigned char *)gss_cbindings->value;
1039 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1040 memcpy(p, (unsigned char *)header->value + 2, header->length - 2);
1041 p += header->length - 2;
1043 memcpy(p, header->value, header->length);
1044 p += header->length;
1047 if ((text->gs2_flags & GS2_CB_FLAG_MASK) == GS2_CB_FLAG_P &&
1049 memcpy(p, cbinding->data, cbinding->len);
1055 #define CHECK_REMAIN(n) do { if (remain < (n)) return SASL_BADPROT; } while (0)
1058 * Verify gs2-header, save authzid and channel bindings to context.
1061 gs2_verify_initial_message(context_t *text,
1062 sasl_server_params_t *sparams,
1067 char *p = (char *)in;
1068 unsigned remain = inlen;
1070 gss_buffer_desc buf = GSS_C_EMPTY_BUFFER;
1072 assert(text->cbindingname == NULL);
1073 assert(text->authzid == NULL);
1076 token->value = NULL;
1078 /* minimum header includes CB flag and non-zero GSS token */
1079 CHECK_REMAIN(4); /* [pny],,. */
1081 /* non-standard GSS framing flag */
1082 if (remain > 1 && memcmp(p, "F,", 2) == 0) {
1083 text->gs2_flags |= GS2_NONSTD_FLAG;
1088 /* SASL channel bindings */
1089 CHECK_REMAIN(1); /* [pny] */
1093 CHECK_REMAIN(1); /* = */
1096 return SASL_BADPROT;
1098 ret = gs2_unescape_authzid(text->utils, &p, &remain, &text->cbindingname);
1102 text->gs2_flags |= GS2_CB_FLAG_P;
1105 text->gs2_flags |= GS2_CB_FLAG_N;
1108 text->gs2_flags |= GS2_CB_FLAG_Y;
1112 CHECK_REMAIN(1); /* , */
1115 return SASL_BADPROT;
1117 /* authorization identity */
1118 if (remain > 1 && memcmp(p, "a=", 2) == 0) {
1123 ret = gs2_unescape_authzid(text->utils, &p, &remain, &text->authzid);
1129 CHECK_REMAIN(1); /* , */
1132 return SASL_BADPROT;
1134 buf.length = inlen - remain;
1135 buf.value = (void *)in;
1137 /* stash channel bindings to pass into gss_accept_sec_context() */
1138 ret = gs2_save_cbindings(text, &buf, sparams->cbinding);
1142 buf.length = remain;
1145 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1146 token->value = text->utils->malloc(buf.length);
1147 if (token->value == NULL)
1150 token->length = buf.length;
1151 memcpy(token->value, buf.value, buf.length);
1153 unsigned int token_size;
1155 /* create a properly formed GSS token */
1156 token_size = gs2_token_size(text->mechanism, buf.length);
1157 token->value = text->utils->malloc(token_size);
1158 if (token->value == NULL)
1161 token->length = token_size;
1163 p = (char *)token->value;
1164 gs2_make_token_header(text->mechanism, buf.length,
1165 (unsigned char **)&p);
1166 memcpy(p, buf.value, buf.length);
1173 * Create gs2-header, save channel bindings to context.
1176 gs2_make_header(context_t *text,
1177 sasl_client_params_t *cparams,
1178 const char *authzid,
1182 size_t required = 0;
1183 size_t wire_authzid_len = 0, cbnamelen = 0;
1184 char *wire_authzid = NULL;
1187 gss_buffer_desc buf;
1192 /* non-standard GSS framing flag */
1193 if (text->gs2_flags & GS2_NONSTD_FLAG)
1194 required += 2; /* F, */
1196 /* SASL channel bindings */
1197 switch (text->gs2_flags & GS2_CB_FLAG_MASK) {
1199 if (!SASL_CB_PRESENT(cparams))
1200 return SASL_BADPARAM;
1201 cbnamelen = strlen(cparams->cbinding->name);
1202 required += 1 /*=*/ + cbnamelen;
1206 required += 2; /* [pny], */
1209 return SASL_BADPARAM;
1212 /* authorization identity */
1213 if (authzid != NULL) {
1214 ret = gs2_escape_authzid(text->utils, authzid,
1215 strlen(authzid), &wire_authzid);
1219 wire_authzid_len = strlen(wire_authzid);
1220 required += 2 /* a= */ + wire_authzid_len;
1223 required += 1; /* trailing comma */
1225 ret = _plug_buf_alloc(text->utils, out, outlen, required);
1226 if (ret != SASL_OK) {
1227 text->utils->free(wire_authzid);
1231 *out = text->out_buf;
1234 p = (char *)text->out_buf;
1235 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1239 switch (text->gs2_flags & GS2_CB_FLAG_MASK) {
1242 memcpy(p + 2, cparams->cbinding->name, cbnamelen);
1253 if (wire_authzid != NULL) {
1255 memcpy(p + 2, wire_authzid, wire_authzid_len);
1256 text->utils->free(wire_authzid);
1257 p += 2 + wire_authzid_len;
1261 assert(p == (char *)text->out_buf + required);
1263 buf.length = required;
1266 ret = gs2_save_cbindings(text, &buf, cparams->cbinding);
1274 * Convert a GSS token to a GS2 one
1277 gs2_make_message(context_t *text,
1278 sasl_client_params_t *cparams __attribute__((unused)),
1279 int initialContextToken,
1284 OM_uint32 major, minor;
1285 unsigned char *mech_token_data;
1286 size_t mech_token_size;
1288 unsigned header_len = 0;
1291 mech_token_size = token->length;
1292 mech_token_data = (unsigned char *)token->value;
1294 if (initialContextToken) {
1295 header_len = *outlen;
1297 major = gs2_verify_token_header(&minor, text->mechanism,
1298 &mech_token_size, &mech_token_data,
1300 if ((major == GSS_S_DEFECTIVE_TOKEN &&
1301 (text->plug.client->features & SASL_FEAT_GSS_FRAMING)) ||
1306 ret = _plug_buf_alloc(text->utils, out, outlen,
1307 header_len + mech_token_size);
1311 p = *out + header_len;
1312 memcpy(p, mech_token_data, mech_token_size);
1314 *outlen = header_len + mech_token_size;
1319 static const unsigned long gs2_required_prompts[] = {
1324 * Map GSS mechanism attributes to SASL ones
1327 gs2_get_mech_attrs(const sasl_utils_t *utils,
1329 unsigned int *security_flags,
1330 unsigned int *features,
1331 const unsigned long **prompts)
1333 OM_uint32 major, minor;
1335 gss_OID_set attrs = GSS_C_NO_OID_SET;
1337 major = gss_inquire_attrs_for_mech(&minor, mech, &attrs, NULL);
1338 if (GSS_ERROR(major)) {
1339 utils->seterror(utils->conn, SASL_NOLOG,
1340 "GS2 Failure: gss_inquire_attrs_for_mech");
1344 *security_flags = SASL_SEC_NOPLAINTEXT | SASL_SEC_NOACTIVE;
1345 *features = SASL_FEAT_WANT_CLIENT_FIRST | SASL_FEAT_CHANNEL_BINDING;
1346 if (prompts != NULL)
1347 *prompts = gs2_required_prompts;
1349 #define MA_PRESENT(a) (gss_test_oid_set_member(&minor, (gss_OID)(a), \
1350 attrs, &present) == GSS_S_COMPLETE && \
1353 if (MA_PRESENT(GSS_C_MA_PFS))
1354 *security_flags |= SASL_SEC_FORWARD_SECRECY;
1355 if (!MA_PRESENT(GSS_C_MA_AUTH_INIT_ANON))
1356 *security_flags |= SASL_SEC_NOANONYMOUS;
1357 if (MA_PRESENT(GSS_C_MA_DELEG_CRED))
1358 *security_flags |= SASL_SEC_PASS_CREDENTIALS;
1359 if (MA_PRESENT(GSS_C_MA_AUTH_TARG))
1360 *security_flags |= SASL_SEC_MUTUAL_AUTH;
1361 if (MA_PRESENT(GSS_C_MA_AUTH_INIT_INIT) && prompts != NULL)
1363 if (MA_PRESENT(GSS_C_MA_ITOK_FRAMED))
1364 *features |= SASL_FEAT_GSS_FRAMING;
1366 gss_release_oid_set(&minor, &attrs);
1372 * Enumerate GSS mechanisms that can be used for GS2
1374 static int gs2_indicate_mechs(const sasl_utils_t *utils)
1376 OM_uint32 major, minor;
1377 gss_OID_desc desired_oids[3];
1378 gss_OID_set_desc desired_attrs;
1379 gss_OID_desc except_oids[3];
1380 gss_OID_set_desc except_attrs;
1382 if (gs2_mechs != GSS_C_NO_OID_SET)
1385 desired_oids[0] = *GSS_C_MA_AUTH_INIT;
1386 desired_oids[1] = *GSS_C_MA_AUTH_TARG;
1387 desired_oids[2] = *GSS_C_MA_CBINDINGS;
1388 desired_attrs.count = sizeof(desired_oids)/sizeof(desired_oids[0]);
1389 desired_attrs.elements = desired_oids;
1391 except_oids[0] = *GSS_C_MA_MECH_NEGO;
1392 except_oids[1] = *GSS_C_MA_NOT_MECH;
1393 except_oids[2] = *GSS_C_MA_DEPRECATED;
1395 except_attrs.count = sizeof(except_oids)/sizeof(except_oids[0]);
1396 except_attrs.elements = except_oids;
1398 major = gss_indicate_mechs_by_attrs(&minor,
1403 if (GSS_ERROR(major)) {
1404 utils->seterror(utils->conn, SASL_NOLOG,
1405 "GS2 Failure: gss_indicate_mechs_by_attrs");
1409 return (gs2_mechs->count > 0) ? SASL_OK : SASL_NOMECH;
1413 * Map SASL mechanism name to OID
1416 gs2_map_sasl_name(const sasl_utils_t *utils,
1420 OM_uint32 major, minor;
1421 gss_buffer_desc buf;
1423 buf.length = strlen(mech);
1424 buf.value = (void *)mech;
1426 major = gss_inquire_mech_for_saslname(&minor, &buf, oid);
1427 if (GSS_ERROR(major)) {
1428 utils->seterror(utils->conn, SASL_NOLOG,
1429 "GS2 Failure: gss_inquire_mech_for_saslname");
1437 gs2_duplicate_buffer(const sasl_utils_t *utils,
1438 const gss_buffer_t src,
1441 dst->value = utils->malloc(src->length + 1);
1442 if (dst->value == NULL)
1445 memcpy(dst->value, src->value, src->length);
1446 ((char *)dst->value)[src->length] = '\0';
1447 dst->length = src->length;
1453 gs2_unescape_authzid(const sasl_utils_t *utils,
1459 size_t i, len, inlen = *remain;
1464 for (i = 0, len = 0; i < inlen; i++) {
1469 } else if (in[i] == '=') {
1471 return SASL_BADPROT;
1477 if (len == 0 || *endp == NULL)
1478 return SASL_BADPROT;
1480 p = *authzid = utils->malloc(len + 1);
1481 if (*authzid == NULL)
1484 for (i = 0; i < inlen; i++) {
1487 else if (in[i] == '=') {
1488 if (memcmp(&in[i + 1], "2C", 2) == 0)
1490 else if (memcmp(&in[i + 1], "3D", 2) == 0)
1493 utils->free(*authzid);
1495 return SASL_BADPROT;
1508 gs2_escape_authzid(const sasl_utils_t *utils,
1516 p = *authzid = utils->malloc((inlen * 3) + 1);
1517 if (*authzid == NULL)
1520 for (i = 0; i < inlen; i++) {
1522 memcpy(p, "=2C", 3);
1524 } else if (in[i] == '=') {
1525 memcpy(p, "=3D", 3);
1538 gs2_ask_user_info(context_t *text,
1539 sasl_client_params_t *params,
1540 char **realms __attribute__((unused)),
1541 int nrealm __attribute__((unused)),
1542 sasl_interact_t **prompt_need,
1543 sasl_out_params_t *oparams)
1545 int result = SASL_OK;
1546 const char *authid = NULL, *userid = NULL;
1547 int user_result = SASL_OK;
1548 int auth_result = SASL_OK;
1549 int pass_result = SASL_OK;
1551 /* try to get the authid */
1552 if (oparams->authid == NULL) {
1553 auth_result = _plug_get_authid(params->utils, &authid, prompt_need);
1555 if (auth_result != SASL_OK && auth_result != SASL_INTERACT) {
1560 /* try to get the userid */
1561 if (oparams->user == NULL) {
1562 user_result = _plug_get_userid(params->utils, &userid, prompt_need);
1564 if (user_result != SASL_OK && user_result != SASL_INTERACT) {
1569 /* try to get the password */
1570 if (text->password == NULL) {
1571 pass_result = _plug_get_password(params->utils, &text->password,
1572 &text->free_password, prompt_need);
1573 if (pass_result != SASL_OK && pass_result != SASL_INTERACT) {
1578 /* free prompts we got */
1579 if (prompt_need && *prompt_need) {
1580 params->utils->free(*prompt_need);
1581 *prompt_need = NULL;
1584 /* if there are prompts not filled in */
1585 if (user_result == SASL_INTERACT || auth_result == SASL_INTERACT ||
1586 pass_result == SASL_INTERACT) {
1588 /* make the prompt list */
1590 _plug_make_prompts(params->utils, prompt_need,
1591 user_result == SASL_INTERACT ?
1592 "Please enter your authorization name" : NULL,
1594 auth_result == SASL_INTERACT ?
1595 "Please enter your authentication name" : NULL,
1597 pass_result == SASL_INTERACT ?
1598 "Please enter your password" : NULL, NULL,
1602 if (result == SASL_OK) return SASL_INTERACT;
1607 if (oparams->authid == NULL) {
1608 if (userid == NULL || userid[0] == '\0') {
1609 result = params->canon_user(params->utils->conn, authid, 0,
1610 SASL_CU_AUTHID | SASL_CU_AUTHZID,
1613 result = params->canon_user(params->utils->conn,
1614 authid, 0, SASL_CU_AUTHID, oparams);
1615 if (result != SASL_OK) return result;
1617 result = params->canon_user(params->utils->conn,
1618 userid, 0, SASL_CU_AUTHZID, oparams);
1620 if (result != SASL_OK)
1628 sasl_gs2_seterror_(const sasl_utils_t *utils, OM_uint32 maj, OM_uint32 min,
1631 OM_uint32 maj_stat, min_stat;
1632 gss_buffer_desc msg;
1636 unsigned int len, curlen = 0;
1637 const char prefix[] = "GSSAPI Error: ";
1639 len = sizeof(prefix);
1640 ret = _plug_buf_alloc(utils, &out, &curlen, 256);
1644 strcpy(out, prefix);
1648 maj_stat = gss_display_status(&min_stat, maj,
1649 GSS_C_GSS_CODE, GSS_C_NULL_OID,
1652 if (GSS_ERROR(maj_stat)) {
1654 utils->log(utils->conn, SASL_LOG_FAIL,
1655 "GS2 Failure: (could not get major error message)");
1657 utils->seterror(utils->conn, 0,
1659 "(could not get major error message)");
1665 len += len + msg.length;
1666 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1667 if (ret != SASL_OK) {
1672 strcat(out, msg.value);
1674 gss_release_buffer(&min_stat, &msg);
1680 /* Now get the minor status */
1683 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1684 if (ret != SASL_OK) {
1693 maj_stat = gss_display_status(&min_stat, min,
1694 GSS_C_MECH_CODE, GSS_C_NULL_OID,
1697 if (GSS_ERROR(maj_stat)) {
1699 utils->log(utils->conn, SASL_LOG_FAIL,
1700 "GS2 Failure: (could not get minor error message)");
1702 utils->seterror(utils->conn, 0,
1704 "(could not get minor error message)");
1710 len += len + msg.length;
1712 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1713 if (ret != SASL_OK) {
1718 strcat(out, msg.value);
1720 gss_release_buffer(&min_stat, &msg);
1727 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1728 if (ret != SASL_OK) {
1736 utils->log(utils->conn, SASL_LOG_FAIL, out);
1738 utils->seterror(utils->conn, 0, out);