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 OM_uint32 out_flags = 0;
345 int ret = 0, equal = 0;
346 int initialContextToken = (text->gss_ctx == GSS_C_NO_CONTEXT);
349 if (serverout == NULL) {
350 PARAMERROR(text->utils);
351 return SASL_BADPARAM;
357 if (initialContextToken) {
358 name_buf.length = strlen(params->service) + 1 + strlen(params->serverFQDN);
359 name_buf.value = params->utils->malloc(name_buf.length + 1);
360 if (name_buf.value == NULL) {
361 MEMERROR(text->utils);
365 snprintf(name_buf.value, name_buf.length + 1,
366 "%s@%s", params->service, params->serverFQDN);
367 maj_stat = gss_import_name(&min_stat,
369 GSS_C_NT_HOSTBASED_SERVICE,
371 params->utils->free(name_buf.value);
372 name_buf.value = NULL;
374 if (GSS_ERROR(maj_stat))
377 assert(text->server_creds == GSS_C_NO_CREDENTIAL);
380 mechs.elements = (gss_OID)text->mechanism;
382 if (params->gss_creds == GSS_C_NO_CREDENTIAL) {
383 maj_stat = gss_acquire_cred(&min_stat,
391 if (GSS_ERROR(maj_stat))
395 ret = gs2_verify_initial_message(text,
403 input_token.value = (void *)clientin;
404 input_token.length = clientinlen;
407 maj_stat = gss_accept_sec_context(&min_stat,
409 (params->gss_creds != GSS_C_NO_CREDENTIAL)
410 ? (gss_cred_id_t)params->gss_creds
411 : text->server_creds,
413 &text->gss_cbindings,
419 &text->client_creds);
420 if (GSS_ERROR(maj_stat)) {
421 sasl_gs2_log(text->utils, maj_stat, min_stat);
422 text->utils->seterror(text->utils->conn, SASL_NOLOG,
423 "GS2 Failure: gss_accept_sec_context");
424 ret = (maj_stat == GSS_S_BAD_BINDINGS) ? SASL_BADBINDING : SASL_BADAUTH;
428 *serveroutlen = output_token.length;
429 if (output_token.value != NULL) {
430 ret = _plug_buf_alloc(text->utils, &text->out_buf,
431 &text->out_buf_len, *serveroutlen);
434 memcpy(text->out_buf, output_token.value, *serveroutlen);
435 *serverout = text->out_buf;
437 /* No output token, send an empty string */
442 if (maj_stat == GSS_S_CONTINUE_NEEDED) {
447 assert(maj_stat == GSS_S_COMPLETE);
449 if ((out_flags & GSS_C_SEQUENCE_FLAG) == 0) {
454 maj_stat = gss_display_name(&min_stat, text->client_name,
456 if (GSS_ERROR(maj_stat))
459 ret = gs2_duplicate_buffer(params->utils, &name_buf, &short_name_buf);
463 p = (char *)memchr(name_buf.value, '@', name_buf.length);
465 short_name_buf.length = (p - (char *)name_buf.value);
467 maj_stat = gss_import_name(&min_stat,
471 if (GSS_ERROR(maj_stat)) {
476 maj_stat = gss_compare_name(&min_stat, text->client_name,
478 if (GSS_ERROR(maj_stat)) {
484 ((char *)short_name_buf.value)[short_name_buf.length] = '\0';
487 text->authid = (char *)short_name_buf.value;
488 short_name_buf.value = NULL;
489 short_name_buf.length = 0;
491 if (text->authzid != NULL) {
492 ret = params->canon_user(params->utils->conn,
494 SASL_CU_AUTHZID, oparams);
499 ret = params->canon_user(params->utils->conn,
501 text->authzid == NULL
502 ? (SASL_CU_AUTHZID | SASL_CU_AUTHID)
508 switch (text->gs2_flags & GS2_CB_FLAG_MASK) {
510 oparams->cbindingdisp = SASL_CB_DISP_NONE;
513 oparams->cbindingdisp = SASL_CB_DISP_USED;
514 oparams->cbindingname = text->cbindingname;
517 oparams->cbindingdisp = SASL_CB_DISP_WANT;
521 if (text->client_creds != GSS_C_NO_CREDENTIAL)
522 oparams->client_creds = &text->client_creds;
524 oparams->client_creds = NULL;
526 oparams->gss_peer_name = text->client_name;
527 oparams->gss_local_name = text->server_name;
528 oparams->maxoutbuf = 0xFFFFFF;
529 oparams->encode = NULL;
530 oparams->decode = NULL;
531 oparams->mech_ssf = 0;
532 oparams->doneflag = 1;
537 if (initialContextToken)
538 gss_release_buffer(&min_stat, &input_token);
539 gss_release_buffer(&min_stat, &name_buf);
540 gss_release_buffer(&min_stat, &short_name_buf);
541 gss_release_buffer(&min_stat, &output_token);
542 gss_release_name(&min_stat, &without);
544 if (ret == SASL_OK && maj_stat != GSS_S_COMPLETE) {
545 sasl_gs2_seterror(text->utils, maj_stat, min_stat);
548 if (ret != SASL_OK && ret != SASL_CONTINUE)
549 sasl_gs2_free_context_contents(text);
555 gs2_common_plug_init(const sasl_utils_t *utils,
557 int (*plug_alloc)(const sasl_utils_t *,
564 OM_uint32 major, minor;
571 if (gs2_indicate_mechs(utils) != SASL_OK) {
575 plugs = utils->malloc(2 * gs2_mechs->count * plugsize);
580 memset(plugs, 0, 2 * gs2_mechs->count * plugsize);
582 for (i = 0; i < gs2_mechs->count; i++) {
583 gss_buffer_desc sasl_mech_name = GSS_C_EMPTY_BUFFER;
585 major = gss_inquire_saslname_for_mech(&minor,
586 &gs2_mechs->elements[i],
590 if (GSS_ERROR(major))
593 #define PLUG_AT(index) (void *)((unsigned char *)plugs + (count * plugsize))
595 if (plug_alloc(utils, PLUG_AT(count), &sasl_mech_name,
596 &gs2_mechs->elements[i]) == SASL_OK)
599 gss_release_buffer(&minor, &sasl_mech_name);
614 gs2_server_plug_alloc(const sasl_utils_t *utils,
616 gss_buffer_t sasl_name,
620 sasl_server_plug_t *splug = (sasl_server_plug_t *)plug;
623 memset(splug, 0, sizeof(*splug));
625 ret = gs2_get_mech_attrs(utils, mech,
626 &splug->security_flags,
632 ret = gs2_duplicate_buffer(utils, sasl_name, &buf);
636 splug->mech_name = (char *)buf.value;
637 splug->glob_context = plug;
638 splug->mech_new = gs2_server_mech_new;
639 splug->mech_step = gs2_server_mech_step;
640 splug->mech_dispose = gs2_common_mech_dispose;
641 splug->mech_free = gs2_common_mech_free;
646 static sasl_server_plug_t *gs2_server_plugins;
647 static int gs2_server_plugcount;
650 gs2_server_plug_init(const sasl_utils_t *utils,
653 sasl_server_plug_t **pluglist,
661 if (maxversion < SASL_SERVER_PLUG_VERSION)
664 *outversion = SASL_SERVER_PLUG_VERSION;
666 if (gs2_server_plugins == NULL) {
667 ret = gs2_common_plug_init(utils,
668 sizeof(sasl_server_plug_t),
669 gs2_server_plug_alloc,
670 (void **)&gs2_server_plugins,
671 &gs2_server_plugcount);
676 *pluglist = gs2_server_plugins;
677 *plugcount = gs2_server_plugcount;
682 /***************************** Client Section *****************************/
684 static int gs2_client_mech_step(void *conn_context,
685 sasl_client_params_t *params,
686 const char *serverin,
687 unsigned serverinlen,
688 sasl_interact_t **prompt_need,
689 const char **clientout,
690 unsigned *clientoutlen,
691 sasl_out_params_t *oparams)
693 context_t *text = (context_t *)conn_context;
694 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
695 gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
696 gss_buffer_desc name_buf = GSS_C_EMPTY_BUFFER;
697 OM_uint32 maj_stat = GSS_S_FAILURE, min_stat = 0;
698 OM_uint32 req_flags, ret_flags;
700 int initialContextToken;
705 if (text->gss_ctx == GSS_C_NO_CONTEXT) {
706 ret = gs2_ask_user_info(text, params, NULL, 0, prompt_need, oparams);
710 if (params->gss_creds == GSS_C_NO_CREDENTIAL &&
711 text->password != NULL && text->password->len != 0) {
712 gss_buffer_desc password_buf;
713 gss_buffer_desc name_buf;
714 gss_OID_set_desc mechs;
716 name_buf.length = strlen(oparams->authid);
717 name_buf.value = (void *)oparams->authid;
719 password_buf.length = text->password->len;
720 password_buf.value = text->password->data;
723 mechs.elements = (gss_OID)text->mechanism;
725 maj_stat = gss_import_name(&min_stat,
729 if (GSS_ERROR(maj_stat))
732 maj_stat = gss_acquire_cred_with_password(&min_stat,
741 if (GSS_ERROR(maj_stat))
745 initialContextToken = 1;
747 initialContextToken = 0;
749 if (text->server_name == GSS_C_NO_NAME) { /* only once */
750 name_buf.length = strlen(params->service) + 1 + strlen(params->serverFQDN);
751 name_buf.value = params->utils->malloc(name_buf.length + 1);
752 if (name_buf.value == NULL) {
756 if (params->serverFQDN == NULL ||
757 strlen(params->serverFQDN) == 0) {
758 SETERROR(text->utils, "GS2 Failure: no serverFQDN");
763 snprintf(name_buf.value, name_buf.length + 1,
764 "%s@%s", params->service, params->serverFQDN);
766 maj_stat = gss_import_name (&min_stat,
768 GSS_C_NT_HOSTBASED_SERVICE,
770 params->utils->free(name_buf.value);
771 name_buf.value = NULL;
773 if (GSS_ERROR(maj_stat))
777 /* From GSSAPI plugin: apparently this is for some IMAP bug workaround */
778 if (serverinlen == 0 && text->gss_ctx != GSS_C_NO_CONTEXT) {
779 gss_delete_sec_context(&min_stat, &text->gss_ctx, GSS_C_NO_BUFFER);
780 text->gss_ctx = GSS_C_NO_CONTEXT;
783 input_token.value = (void *)serverin;
784 input_token.length = serverinlen;
786 if (initialContextToken) {
787 if ((text->plug.client->features & SASL_FEAT_GSS_FRAMING) == 0)
788 text->gs2_flags |= GS2_NONSTD_FLAG;
790 switch (params->cbindingdisp) {
791 case SASL_CB_DISP_NONE:
792 text->gs2_flags |= GS2_CB_FLAG_N;
794 case SASL_CB_DISP_USED:
795 text->gs2_flags |= GS2_CB_FLAG_P;
797 case SASL_CB_DISP_WANT:
798 text->gs2_flags |= GS2_CB_FLAG_Y;
802 ret = gs2_make_header(text, params,
803 strcmp(oparams->user, oparams->authid) ?
804 (char *) oparams->user : NULL,
805 &text->out_buf, &text->out_buf_len);
810 req_flags = GSS_C_MUTUAL_FLAG | GSS_C_SEQUENCE_FLAG;
812 maj_stat = gss_init_sec_context(&min_stat,
813 (params->gss_creds != GSS_C_NO_CREDENTIAL)
814 ? (gss_cred_id_t)params->gss_creds
815 : text->client_creds,
818 (gss_OID)text->mechanism,
821 &text->gss_cbindings,
822 serverinlen ? &input_token : GSS_C_NO_BUFFER,
827 if (GSS_ERROR(maj_stat))
830 ret = gs2_make_message(text, params, initialContextToken, &output_token,
831 &text->out_buf, &text->out_buf_len);
835 *clientout = text->out_buf;
836 *clientoutlen = text->out_buf_len;
838 if (maj_stat == GSS_S_CONTINUE_NEEDED) {
843 if (text->client_name != GSS_C_NO_NAME)
844 gss_release_name(&min_stat, &text->client_name);
846 maj_stat = gss_inquire_context(&min_stat,
852 &ret_flags, /* flags */
855 if (GSS_ERROR(maj_stat))
858 if ((ret_flags & req_flags) != req_flags) {
859 maj_stat = SASL_BADAUTH;
863 maj_stat = gss_display_name(&min_stat,
867 if (GSS_ERROR(maj_stat))
870 oparams->gss_peer_name = text->server_name;
871 oparams->gss_local_name = text->client_name;
872 oparams->encode = NULL;
873 oparams->decode = NULL;
874 oparams->mech_ssf = 0;
875 oparams->maxoutbuf = 0xFFFFFF;
876 oparams->doneflag = 1;
879 gss_release_buffer(&min_stat, &output_token);
880 gss_release_buffer(&min_stat, &name_buf);
882 if (ret == SASL_OK && maj_stat != GSS_S_COMPLETE) {
883 sasl_gs2_seterror(text->utils, maj_stat, min_stat);
886 if (ret != SASL_OK && ret != SASL_CONTINUE)
887 sasl_gs2_free_context_contents(text);
892 static int gs2_client_mech_new(void *glob_context,
893 sasl_client_params_t *params,
899 text = sasl_gs2_new_context(params->utils);
901 MEMERROR(params->utils);
905 text->gss_ctx = GSS_C_NO_CONTEXT;
906 text->client_name = GSS_C_NO_NAME;
907 text->server_creds = GSS_C_NO_CREDENTIAL;
908 text->client_creds = GSS_C_NO_CREDENTIAL;
909 text->plug.client = glob_context;
911 ret = gs2_map_sasl_name(params->utils, text->plug.client->mech_name,
913 if (ret != SASL_OK) {
914 gs2_common_mech_dispose(text, params->utils);
918 *conn_context = text;
924 gs2_client_plug_alloc(const sasl_utils_t *utils,
926 gss_buffer_t sasl_name,
930 sasl_client_plug_t *cplug = (sasl_client_plug_t *)plug;
933 memset(cplug, 0, sizeof(*cplug));
935 ret = gs2_get_mech_attrs(utils, mech,
936 &cplug->security_flags,
938 &cplug->required_prompts);
942 ret = gs2_duplicate_buffer(utils, sasl_name, &buf);
946 cplug->mech_name = (char *)buf.value;
947 cplug->features |= SASL_FEAT_NEEDSERVERFQDN;
948 cplug->glob_context = plug;
949 cplug->mech_new = gs2_client_mech_new;
950 cplug->mech_step = gs2_client_mech_step;
951 cplug->mech_dispose = gs2_common_mech_dispose;
952 cplug->mech_free = gs2_common_mech_free;
957 static sasl_client_plug_t *gs2_client_plugins;
958 static int gs2_client_plugcount;
961 gs2_client_plug_init(const sasl_utils_t *utils,
964 sasl_client_plug_t **pluglist,
972 if (maxversion < SASL_CLIENT_PLUG_VERSION)
975 *outversion = SASL_CLIENT_PLUG_VERSION;
977 if (gs2_client_plugins == NULL) {
978 ret = gs2_common_plug_init(utils,
979 sizeof(sasl_client_plug_t),
980 gs2_client_plug_alloc,
981 (void **)&gs2_client_plugins,
982 &gs2_client_plugcount);
987 *pluglist = gs2_client_plugins;
988 *plugcount = gs2_client_plugcount;
994 * Copy header and application channel bindings to GSS channel bindings
995 * structure in context.
998 gs2_save_cbindings(context_t *text,
1000 const sasl_channel_binding_t *cbinding)
1002 gss_buffer_t gss_cbindings = &text->gss_cbindings.application_data;
1006 assert(gss_cbindings->value == NULL);
1009 * The application-data field MUST be set to the gs2-header, excluding
1010 * the initial [gs2-nonstd-flag ","] part, concatenated with, when a
1011 * gs2-cb-flag of "p" is used, the application's channel binding data.
1013 len = header->length;
1014 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1018 if ((text->gs2_flags & GS2_CB_FLAG_MASK) == GS2_CB_FLAG_P &&
1020 len += cbinding->len;
1023 gss_cbindings->length = len;
1024 gss_cbindings->value = text->utils->malloc(len);
1025 if (gss_cbindings->value == NULL)
1028 p = (unsigned char *)gss_cbindings->value;
1029 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1030 memcpy(p, (unsigned char *)header->value + 2, header->length - 2);
1031 p += header->length - 2;
1033 memcpy(p, header->value, header->length);
1034 p += header->length;
1037 if ((text->gs2_flags & GS2_CB_FLAG_MASK) == GS2_CB_FLAG_P &&
1039 memcpy(p, cbinding->data, cbinding->len);
1045 #define CHECK_REMAIN(n) do { if (remain < (n)) return SASL_BADPROT; } while (0)
1048 * Verify gs2-header, save authzid and channel bindings to context.
1051 gs2_verify_initial_message(context_t *text,
1052 sasl_server_params_t *sparams,
1057 char *p = (char *)in;
1058 unsigned remain = inlen;
1060 gss_buffer_desc buf = GSS_C_EMPTY_BUFFER;
1062 assert(text->cbindingname == NULL);
1063 assert(text->authzid == NULL);
1066 token->value = NULL;
1068 /* minimum header includes CB flag and non-zero GSS token */
1069 CHECK_REMAIN(4); /* [pny],,. */
1071 /* non-standard GSS framing flag */
1072 if (remain > 1 && memcmp(p, "F,", 2) == 0) {
1073 text->gs2_flags |= GS2_NONSTD_FLAG;
1078 /* SASL channel bindings */
1079 CHECK_REMAIN(1); /* [pny] */
1083 CHECK_REMAIN(1); /* = */
1086 return SASL_BADPROT;
1088 ret = gs2_unescape_authzid(text->utils, &p, &remain, &text->cbindingname);
1092 text->gs2_flags |= GS2_CB_FLAG_P;
1095 text->gs2_flags |= GS2_CB_FLAG_N;
1098 text->gs2_flags |= GS2_CB_FLAG_Y;
1102 CHECK_REMAIN(1); /* , */
1105 return SASL_BADPROT;
1107 /* authorization identity */
1108 if (remain > 1 && memcmp(p, "a=", 2) == 0) {
1113 ret = gs2_unescape_authzid(text->utils, &p, &remain, &text->authzid);
1119 CHECK_REMAIN(1); /* , */
1122 return SASL_BADPROT;
1124 buf.length = inlen - remain;
1125 buf.value = (void *)in;
1127 /* stash channel bindings to pass into gss_accept_sec_context() */
1128 ret = gs2_save_cbindings(text, &buf, sparams->cbinding);
1132 buf.length = remain;
1135 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1136 token->value = text->utils->malloc(buf.length);
1137 if (token->value == NULL)
1140 token->length = buf.length;
1141 memcpy(token->value, buf.value, buf.length);
1143 unsigned int token_size;
1145 /* create a properly formed GSS token */
1146 token_size = gs2_token_size(text->mechanism, buf.length);
1147 token->value = text->utils->malloc(token_size);
1148 if (token->value == NULL)
1151 token->length = token_size;
1153 p = (char *)token->value;
1154 gs2_make_token_header(text->mechanism, buf.length,
1155 (unsigned char **)&p);
1156 memcpy(p, buf.value, buf.length);
1163 * Create gs2-header, save channel bindings to context.
1166 gs2_make_header(context_t *text,
1167 sasl_client_params_t *cparams,
1168 const char *authzid,
1172 size_t required = 0;
1173 size_t wire_authzid_len = 0, cbnamelen = 0;
1174 char *wire_authzid = NULL;
1177 gss_buffer_desc buf;
1182 /* non-standard GSS framing flag */
1183 if (text->gs2_flags & GS2_NONSTD_FLAG)
1184 required += 2; /* F, */
1186 /* SASL channel bindings */
1187 switch (text->gs2_flags & GS2_CB_FLAG_MASK) {
1189 if (!SASL_CB_PRESENT(cparams))
1190 return SASL_BADPARAM;
1191 cbnamelen = strlen(cparams->cbinding->name);
1192 required += 1 /*=*/ + cbnamelen;
1196 required += 2; /* [pny], */
1199 return SASL_BADPARAM;
1202 /* authorization identity */
1203 if (authzid != NULL) {
1204 ret = gs2_escape_authzid(text->utils, authzid,
1205 strlen(authzid), &wire_authzid);
1209 wire_authzid_len = strlen(wire_authzid);
1210 required += 2 /* a= */ + wire_authzid_len;
1213 required += 1; /* trailing comma */
1215 ret = _plug_buf_alloc(text->utils, out, outlen, required);
1216 if (ret != SASL_OK) {
1217 text->utils->free(wire_authzid);
1221 *out = text->out_buf;
1224 p = (char *)text->out_buf;
1225 if (text->gs2_flags & GS2_NONSTD_FLAG) {
1229 switch (text->gs2_flags & GS2_CB_FLAG_MASK) {
1232 memcpy(p + 2, cparams->cbinding->name, cbnamelen);
1243 if (wire_authzid != NULL) {
1245 memcpy(p + 2, wire_authzid, wire_authzid_len);
1246 text->utils->free(wire_authzid);
1247 p += 2 + wire_authzid_len;
1251 assert(p == (char *)text->out_buf + required);
1253 buf.length = required;
1256 ret = gs2_save_cbindings(text, &buf, cparams->cbinding);
1264 * Convert a GSS token to a GS2 one
1267 gs2_make_message(context_t *text,
1268 sasl_client_params_t *cparams __attribute__((unused)),
1269 int initialContextToken,
1274 OM_uint32 major, minor;
1275 unsigned char *mech_token_data;
1276 size_t mech_token_size;
1278 unsigned header_len = 0;
1281 mech_token_size = token->length;
1282 mech_token_data = (unsigned char *)token->value;
1284 if (initialContextToken) {
1285 header_len = *outlen;
1287 major = gs2_verify_token_header(&minor, text->mechanism,
1288 &mech_token_size, &mech_token_data,
1290 if ((major == GSS_S_DEFECTIVE_TOKEN &&
1291 (text->plug.client->features & SASL_FEAT_GSS_FRAMING)) ||
1296 ret = _plug_buf_alloc(text->utils, out, outlen,
1297 header_len + mech_token_size);
1301 p = *out + header_len;
1302 memcpy(p, mech_token_data, mech_token_size);
1304 *outlen = header_len + mech_token_size;
1309 static const unsigned long gs2_required_prompts[] = {
1314 * Map GSS mechanism attributes to SASL ones
1317 gs2_get_mech_attrs(const sasl_utils_t *utils,
1319 unsigned int *security_flags,
1320 unsigned int *features,
1321 const unsigned long **prompts)
1323 OM_uint32 major, minor;
1325 gss_OID_set attrs = GSS_C_NO_OID_SET;
1327 major = gss_inquire_attrs_for_mech(&minor, mech, &attrs, NULL);
1328 if (GSS_ERROR(major)) {
1329 utils->seterror(utils->conn, SASL_NOLOG,
1330 "GS2 Failure: gss_inquire_attrs_for_mech");
1334 *security_flags = SASL_SEC_NOPLAINTEXT | SASL_SEC_NOACTIVE;
1335 *features = SASL_FEAT_WANT_CLIENT_FIRST | SASL_FEAT_CHANNEL_BINDING;
1336 if (prompts != NULL)
1337 *prompts = gs2_required_prompts;
1339 #define MA_PRESENT(a) (gss_test_oid_set_member(&minor, (gss_OID)(a), \
1340 attrs, &present) == GSS_S_COMPLETE && \
1343 if (MA_PRESENT(GSS_C_MA_PFS))
1344 *security_flags |= SASL_SEC_FORWARD_SECRECY;
1345 if (!MA_PRESENT(GSS_C_MA_AUTH_INIT_ANON))
1346 *security_flags |= SASL_SEC_NOANONYMOUS;
1347 if (MA_PRESENT(GSS_C_MA_DELEG_CRED))
1348 *security_flags |= SASL_SEC_PASS_CREDENTIALS;
1349 if (MA_PRESENT(GSS_C_MA_AUTH_TARG))
1350 *security_flags |= SASL_SEC_MUTUAL_AUTH;
1351 if (MA_PRESENT(GSS_C_MA_AUTH_INIT_INIT) && prompts != NULL)
1353 if (MA_PRESENT(GSS_C_MA_ITOK_FRAMED))
1354 *features |= SASL_FEAT_GSS_FRAMING;
1356 gss_release_oid_set(&minor, &attrs);
1362 * Enumerate GSS mechanisms that can be used for GS2
1364 static int gs2_indicate_mechs(const sasl_utils_t *utils)
1366 OM_uint32 major, minor;
1367 gss_OID_desc desired_oids[3];
1368 gss_OID_set_desc desired_attrs;
1369 gss_OID_desc except_oids[3];
1370 gss_OID_set_desc except_attrs;
1372 if (gs2_mechs != GSS_C_NO_OID_SET)
1375 desired_oids[0] = *GSS_C_MA_AUTH_INIT;
1376 desired_oids[1] = *GSS_C_MA_AUTH_TARG;
1377 desired_oids[2] = *GSS_C_MA_CBINDINGS;
1378 desired_attrs.count = sizeof(desired_oids)/sizeof(desired_oids[0]);
1379 desired_attrs.elements = desired_oids;
1381 except_oids[0] = *GSS_C_MA_MECH_NEGO;
1382 except_oids[1] = *GSS_C_MA_NOT_MECH;
1383 except_oids[2] = *GSS_C_MA_DEPRECATED;
1385 except_attrs.count = sizeof(except_oids)/sizeof(except_oids[0]);
1386 except_attrs.elements = except_oids;
1388 major = gss_indicate_mechs_by_attrs(&minor,
1393 if (GSS_ERROR(major)) {
1394 utils->seterror(utils->conn, SASL_NOLOG,
1395 "GS2 Failure: gss_indicate_mechs_by_attrs");
1399 return (gs2_mechs->count > 0) ? SASL_OK : SASL_NOMECH;
1403 * Map SASL mechanism name to OID
1406 gs2_map_sasl_name(const sasl_utils_t *utils,
1410 OM_uint32 major, minor;
1411 gss_buffer_desc buf;
1413 buf.length = strlen(mech);
1414 buf.value = (void *)mech;
1416 major = gss_inquire_mech_for_saslname(&minor, &buf, oid);
1417 if (GSS_ERROR(major)) {
1418 utils->seterror(utils->conn, SASL_NOLOG,
1419 "GS2 Failure: gss_inquire_mech_for_saslname");
1427 gs2_duplicate_buffer(const sasl_utils_t *utils,
1428 const gss_buffer_t src,
1431 dst->value = utils->malloc(src->length + 1);
1432 if (dst->value == NULL)
1435 memcpy(dst->value, src->value, src->length);
1436 ((char *)dst->value)[src->length] = '\0';
1437 dst->length = src->length;
1443 gs2_unescape_authzid(const sasl_utils_t *utils,
1449 size_t i, len, inlen = *remain;
1454 for (i = 0, len = 0; i < inlen; i++) {
1459 } else if (in[i] == '=') {
1461 return SASL_BADPROT;
1467 if (len == 0 || *endp == NULL)
1468 return SASL_BADPROT;
1470 p = *authzid = utils->malloc(len + 1);
1471 if (*authzid == NULL)
1474 for (i = 0; i < inlen; i++) {
1477 else if (in[i] == '=') {
1478 if (memcmp(&in[i + 1], "2C", 2) == 0)
1480 else if (memcmp(&in[i + 1], "3D", 2) == 0)
1483 utils->free(*authzid);
1485 return SASL_BADPROT;
1498 gs2_escape_authzid(const sasl_utils_t *utils,
1506 p = *authzid = utils->malloc((inlen * 3) + 1);
1507 if (*authzid == NULL)
1510 for (i = 0; i < inlen; i++) {
1512 memcpy(p, "=2C", 3);
1514 } else if (in[i] == '=') {
1515 memcpy(p, "=3D", 3);
1528 gs2_ask_user_info(context_t *text,
1529 sasl_client_params_t *params,
1530 char **realms __attribute__((unused)),
1531 int nrealm __attribute__((unused)),
1532 sasl_interact_t **prompt_need,
1533 sasl_out_params_t *oparams)
1535 int result = SASL_OK;
1536 const char *authid = NULL, *userid = NULL;
1537 int user_result = SASL_OK;
1538 int auth_result = SASL_OK;
1539 int pass_result = SASL_OK;
1541 /* try to get the authid */
1542 if (oparams->authid == NULL) {
1543 auth_result = _plug_get_authid(params->utils, &authid, prompt_need);
1545 if (auth_result != SASL_OK && auth_result != SASL_INTERACT) {
1550 /* try to get the userid */
1551 if (oparams->user == NULL) {
1552 user_result = _plug_get_userid(params->utils, &userid, prompt_need);
1554 if (user_result != SASL_OK && user_result != SASL_INTERACT) {
1559 /* try to get the password */
1560 if (text->password == NULL) {
1561 pass_result = _plug_get_password(params->utils, &text->password,
1562 &text->free_password, prompt_need);
1563 if (pass_result != SASL_OK && pass_result != SASL_INTERACT) {
1568 /* free prompts we got */
1569 if (prompt_need && *prompt_need) {
1570 params->utils->free(*prompt_need);
1571 *prompt_need = NULL;
1574 /* if there are prompts not filled in */
1575 if (user_result == SASL_INTERACT || auth_result == SASL_INTERACT ||
1576 pass_result == SASL_INTERACT) {
1578 /* make the prompt list */
1580 _plug_make_prompts(params->utils, prompt_need,
1581 user_result == SASL_INTERACT ?
1582 "Please enter your authorization name" : NULL,
1584 auth_result == SASL_INTERACT ?
1585 "Please enter your authentication name" : NULL,
1587 pass_result == SASL_INTERACT ?
1588 "Please enter your password" : NULL, NULL,
1592 if (result == SASL_OK) return SASL_INTERACT;
1597 if (oparams->authid == NULL) {
1598 if (userid == NULL || userid[0] == '\0') {
1599 result = params->canon_user(params->utils->conn, authid, 0,
1600 SASL_CU_AUTHID | SASL_CU_AUTHZID,
1603 result = params->canon_user(params->utils->conn,
1604 authid, 0, SASL_CU_AUTHID, oparams);
1605 if (result != SASL_OK) return result;
1607 result = params->canon_user(params->utils->conn,
1608 userid, 0, SASL_CU_AUTHZID, oparams);
1610 if (result != SASL_OK)
1618 sasl_gs2_seterror_(const sasl_utils_t *utils, OM_uint32 maj, OM_uint32 min,
1621 OM_uint32 maj_stat, min_stat;
1622 gss_buffer_desc msg;
1626 unsigned int len, curlen = 0;
1627 const char prefix[] = "GSSAPI Error: ";
1629 len = sizeof(prefix);
1630 ret = _plug_buf_alloc(utils, &out, &curlen, 256);
1634 strcpy(out, prefix);
1638 maj_stat = gss_display_status(&min_stat, maj,
1639 GSS_C_GSS_CODE, GSS_C_NULL_OID,
1642 if (GSS_ERROR(maj_stat)) {
1644 utils->log(utils->conn, SASL_LOG_FAIL,
1645 "GS2 Failure: (could not get major error message)");
1647 utils->seterror(utils->conn, 0,
1649 "(could not get major error message)");
1655 len += len + msg.length;
1656 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1657 if (ret != SASL_OK) {
1662 strcat(out, msg.value);
1664 gss_release_buffer(&min_stat, &msg);
1670 /* Now get the minor status */
1673 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1674 if (ret != SASL_OK) {
1683 maj_stat = gss_display_status(&min_stat, min,
1684 GSS_C_MECH_CODE, GSS_C_NULL_OID,
1687 if (GSS_ERROR(maj_stat)) {
1689 utils->log(utils->conn, SASL_LOG_FAIL,
1690 "GS2 Failure: (could not get minor error message)");
1692 utils->seterror(utils->conn, 0,
1694 "(could not get minor error message)");
1700 len += len + msg.length;
1702 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1703 if (ret != SASL_OK) {
1708 strcat(out, msg.value);
1710 gss_release_buffer(&min_stat, &msg);
1717 ret = _plug_buf_alloc(utils, &out, &curlen, len);
1718 if (ret != SASL_OK) {
1726 utils->log(utils->conn, SASL_LOG_FAIL, out);
1728 utils->seterror(utils->conn, 0, out);