2 * Copyright (c) 2011, JANET(UK)
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. Neither the name of JANET(UK) nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Utility routines for credential handles.
37 #include "gssapiP_eap.h"
40 # include <shlobj.h> /* may need to use ShFolder.h instead */
47 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred)
52 *pCred = GSS_C_NO_CREDENTIAL;
54 cred = (gss_cred_id_t)GSSEAP_CALLOC(1, sizeof(*cred));
60 if (GSSEAP_MUTEX_INIT(&cred->mutex) != 0) {
61 *minor = GSSEAP_GET_LAST_ERROR();
62 gssEapReleaseCred(&tmpMinor, &cred);
69 return GSS_S_COMPLETE;
73 zeroAndReleasePassword(gss_buffer_t password)
75 GSSEAP_ASSERT(password != GSS_C_NO_BUFFER);
77 if (password->value != NULL) {
78 memset(password->value, 0, password->length);
79 GSSEAP_FREE(password->value);
82 password->value = NULL;
87 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred)
90 gss_cred_id_t cred = *pCred;
91 krb5_context krbContext = NULL;
93 if (cred == GSS_C_NO_CREDENTIAL) {
94 return GSS_S_COMPLETE;
97 GSSEAP_KRB_INIT(&krbContext);
99 gssEapReleaseName(&tmpMinor, &cred->name);
100 gssEapReleaseName(&tmpMinor, &cred->target);
102 zeroAndReleasePassword(&cred->password);
104 gss_release_buffer(&tmpMinor, &cred->radiusConfigFile);
105 gss_release_buffer(&tmpMinor, &cred->radiusConfigStanza);
106 gss_release_buffer(&tmpMinor, &cred->caCertificate);
107 gss_release_buffer(&tmpMinor, &cred->caCertificateBlob);
108 gss_release_buffer(&tmpMinor, &cred->subjectNameConstraint);
109 gss_release_buffer(&tmpMinor, &cred->subjectAltNameConstraint);
110 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
111 gss_release_buffer(&tmpMinor, &cred->privateKey);
113 #ifdef GSSEAP_ENABLE_REAUTH
114 if (cred->krbCredCache != NULL) {
115 if (cred->flags & CRED_FLAG_DEFAULT_CCACHE)
116 krb5_cc_close(krbContext, cred->krbCredCache);
118 krb5_cc_destroy(krbContext, cred->krbCredCache);
120 if (cred->reauthCred != GSS_C_NO_CREDENTIAL)
121 gssReleaseCred(&tmpMinor, &cred->reauthCred);
124 GSSEAP_MUTEX_DESTROY(&cred->mutex);
125 memset(cred, 0, sizeof(*cred));
130 return GSS_S_COMPLETE;
134 readStaticIdentityFile(OM_uint32 *minor,
135 gss_buffer_t defaultIdentity,
136 gss_buffer_t defaultPassword)
138 OM_uint32 major, tmpMinor;
144 struct passwd *pw = NULL, pwd;
148 defaultIdentity->length = 0;
149 defaultIdentity->value = NULL;
151 if (defaultPassword != GSS_C_NO_BUFFER) {
152 defaultPassword->length = 0;
153 defaultPassword->value = NULL;
156 ccacheName = getenv("GSSEAP_IDENTITY");
157 if (ccacheName == NULL) {
159 TCHAR szPath[MAX_PATH];
161 if (!SUCCEEDED(SHGetFolderPath(NULL,
162 CSIDL_APPDATA, /* |CSIDL_FLAG_CREATE */
163 NULL, /* User access token */
164 0, /* SHGFP_TYPE_CURRENT */
166 major = GSS_S_CRED_UNAVAIL;
167 *minor = GSSEAP_GET_LAST_ERROR(); /* XXX */
171 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", szPath);
173 if (getpwuid_r(getuid(), &pwd, pwbuf, sizeof(pwbuf), &pw) != 0 ||
174 pw == NULL || pw->pw_dir == NULL) {
175 major = GSS_S_CRED_UNAVAIL;
176 *minor = GSSEAP_GET_LAST_ERROR();
180 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", pw->pw_dir);
185 fp = fopen(ccacheName, "r");
187 major = GSS_S_CRED_UNAVAIL;
188 *minor = GSSEAP_NO_DEFAULT_CRED;
192 while (fgets(buf, sizeof(buf), fp) != NULL) {
193 gss_buffer_desc src, *dst;
195 src.length = strlen(buf);
201 if (buf[src.length - 1] == '\n') {
202 buf[src.length - 1] = '\0';
203 if (--src.length == 0)
208 dst = defaultIdentity;
210 dst = defaultPassword;
214 if (dst != GSS_C_NO_BUFFER) {
215 major = duplicateBuffer(minor, &src, dst);
216 if (GSS_ERROR(major))
223 if (defaultIdentity->length == 0) {
224 major = GSS_S_CRED_UNAVAIL;
225 *minor = GSSEAP_NO_DEFAULT_CRED;
229 major = GSS_S_COMPLETE;
236 if (GSS_ERROR(major)) {
237 gss_release_buffer(&tmpMinor, defaultIdentity);
238 zeroAndReleasePassword(defaultPassword);
241 memset(buf, 0, sizeof(buf));
247 gssEapPrimaryMechForCred(gss_cred_id_t cred)
249 gss_OID credMech = GSS_C_NO_OID;
251 if (cred != GSS_C_NO_CREDENTIAL &&
252 cred->mechanisms != GSS_C_NO_OID_SET &&
253 cred->mechanisms->count == 1)
254 credMech = &cred->mechanisms->elements[0];
260 gssEapAcquireCred(OM_uint32 *minor,
261 gss_const_name_t desiredName,
262 OM_uint32 timeReq GSSEAP_UNUSED,
263 const gss_OID_set desiredMechs,
265 gss_cred_id_t *pCred,
266 gss_OID_set *pActualMechs,
269 OM_uint32 major, tmpMinor;
272 /* XXX TODO validate with changed set_cred_option API */
273 *pCred = GSS_C_NO_CREDENTIAL;
275 major = gssEapAllocCred(minor, &cred);
276 if (GSS_ERROR(major))
281 cred->flags |= CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT;
284 cred->flags |= CRED_FLAG_INITIATE;
287 cred->flags |= CRED_FLAG_ACCEPT;
290 major = GSS_S_FAILURE;
291 *minor = GSSEAP_BAD_USAGE;
296 major = gssEapValidateMechs(minor, desiredMechs);
297 if (GSS_ERROR(major))
300 major = duplicateOidSet(minor, desiredMechs, &cred->mechanisms);
301 if (GSS_ERROR(major))
304 if (desiredName != GSS_C_NO_NAME) {
305 GSSEAP_MUTEX_LOCK(&((gss_name_t)desiredName)->mutex);
307 major = gssEapDuplicateName(minor, desiredName, &cred->name);
308 if (GSS_ERROR(major)) {
309 GSSEAP_MUTEX_UNLOCK(&((gss_name_t)desiredName)->mutex);
313 GSSEAP_MUTEX_UNLOCK(&((gss_name_t)desiredName)->mutex);
316 #ifdef GSSEAP_ENABLE_ACCEPTOR
317 if (cred->flags & CRED_FLAG_ACCEPT) {
318 struct rs_context *radContext;
320 major = gssEapCreateRadiusContext(minor, cred, &radContext);
321 if (GSS_ERROR(major))
324 rs_context_destroy(radContext);
328 if (pActualMechs != NULL) {
329 major = duplicateOidSet(minor, cred->mechanisms, pActualMechs);
330 if (GSS_ERROR(major))
335 *timeRec = GSS_C_INDEFINITE;
339 major = GSS_S_COMPLETE;
343 if (GSS_ERROR(major))
344 gssEapReleaseCred(&tmpMinor, &cred);
346 gssEapTraceStatus("gss_acquire_cred", major, *minor);
352 * Return TRUE if cred available for mechanism. Caller need no acquire
353 * lock because mechanisms list is immutable.
356 gssEapCredAvailable(gss_const_cred_id_t cred, gss_OID mech)
361 GSSEAP_ASSERT(mech != GSS_C_NO_OID);
363 if (cred == GSS_C_NO_CREDENTIAL || cred->mechanisms == GSS_C_NO_OID_SET)
366 gss_test_oid_set_member(&minor, mech, cred->mechanisms, &present);
372 staticIdentityFileResolveDefaultIdentity(OM_uint32 *minor,
373 const gss_cred_id_t cred,
376 OM_uint32 major, tmpMinor;
377 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
378 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
380 *pName = GSS_C_NO_NAME;
382 major = readStaticIdentityFile(minor, &defaultIdentity, GSS_C_NO_BUFFER);
383 if (major == GSS_S_COMPLETE) {
384 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
388 gss_release_buffer(&tmpMinor, &defaultIdentity);
394 gssEapResolveCredIdentity(OM_uint32 *minor,
398 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
400 if (cred->name != GSS_C_NO_NAME) {
402 return GSS_S_COMPLETE;
405 if (cred->flags & CRED_FLAG_ACCEPT) {
406 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
407 char serviceName[5 + MAXHOSTNAMELEN];
409 /* default host-based service is host@localhost */
410 memcpy(serviceName, "host@", 5);
411 if (gethostname(&serviceName[5], MAXHOSTNAMELEN) != 0) {
412 *minor = GSSEAP_NO_HOSTNAME;
413 return GSS_S_FAILURE;
416 nameBuf.value = serviceName;
417 nameBuf.length = strlen((char *)nameBuf.value);
419 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_HOSTBASED_SERVICE,
420 nameMech, &cred->name);
421 if (GSS_ERROR(major))
423 } else if (cred->flags & CRED_FLAG_INITIATE) {
424 #ifdef HAVE_MOONSHOT_GET_IDENTITY
425 major = libMoonshotResolveDefaultIdentity(minor, cred, &cred->name);
426 if (major == GSS_S_CRED_UNAVAIL)
428 major = staticIdentityFileResolveDefaultIdentity(minor, cred, &cred->name);
429 if (major != GSS_S_CRED_UNAVAIL)
434 return GSS_S_COMPLETE;
438 gssEapInquireCred(OM_uint32 *minor,
441 OM_uint32 *pLifetime,
442 gss_cred_usage_t *cred_usage,
443 gss_OID_set *mechanisms)
446 time_t now, lifetime;
449 major = gssEapResolveCredIdentity(minor, cred);
450 if (GSS_ERROR(major))
453 if (cred->name != GSS_C_NO_NAME) {
454 major = gssEapDuplicateName(minor, cred->name, name);
455 if (GSS_ERROR(major))
458 *name = GSS_C_NO_NAME;
461 if (cred_usage != NULL) {
462 OM_uint32 flags = (cred->flags & (CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT));
465 case CRED_FLAG_INITIATE:
466 *cred_usage = GSS_C_INITIATE;
468 case CRED_FLAG_ACCEPT:
469 *cred_usage = GSS_C_ACCEPT;
472 *cred_usage = GSS_C_BOTH;
477 if (mechanisms != NULL) {
478 if (cred->mechanisms != GSS_C_NO_OID_SET)
479 major = duplicateOidSet(minor, cred->mechanisms, mechanisms);
481 major = gssEapIndicateMechs(minor, mechanisms);
482 if (GSS_ERROR(major))
486 if (cred->expiryTime == 0) {
487 lifetime = GSS_C_INDEFINITE;
490 lifetime = now - cred->expiryTime;
495 if (pLifetime != NULL) {
496 *pLifetime = lifetime;
500 major = GSS_S_CREDENTIALS_EXPIRED;
501 *minor = GSSEAP_CRED_EXPIRED;
505 major = GSS_S_COMPLETE;
513 gssEapSetCredPassword(OM_uint32 *minor,
515 const gss_buffer_t password)
517 OM_uint32 major, tmpMinor;
518 gss_buffer_desc newPassword = GSS_C_EMPTY_BUFFER;
520 if (cred->flags & CRED_FLAG_RESOLVED) {
521 major = GSS_S_FAILURE;
522 *minor = GSSEAP_CRED_RESOLVED;
526 if (password != GSS_C_NO_BUFFER) {
527 major = duplicateBuffer(minor, password, &newPassword);
528 if (GSS_ERROR(major))
531 cred->flags |= CRED_FLAG_PASSWORD;
533 cred->flags &= ~(CRED_FLAG_PASSWORD);
536 gss_release_buffer(&tmpMinor, &cred->password);
537 cred->password = newPassword;
539 major = GSS_S_COMPLETE;
547 * Currently only the privateKey path is exposed to the application
548 * (via gss_set_cred_option() or the third line in ~/.gss_eap_id).
549 * At some point in the future we may add support for setting the
550 * client certificate separately.
553 gssEapSetCredClientCertificate(OM_uint32 *minor,
555 const gss_buffer_t clientCert,
556 const gss_buffer_t privateKey)
558 OM_uint32 major, tmpMinor;
559 gss_buffer_desc newClientCert = GSS_C_EMPTY_BUFFER;
560 gss_buffer_desc newPrivateKey = GSS_C_EMPTY_BUFFER;
562 if (cred->flags & CRED_FLAG_RESOLVED) {
563 major = GSS_S_FAILURE;
564 *minor = GSSEAP_CRED_RESOLVED;
568 if (clientCert == GSS_C_NO_BUFFER &&
569 privateKey == GSS_C_NO_BUFFER) {
570 cred->flags &= ~(CRED_FLAG_CERTIFICATE);
571 major = GSS_S_COMPLETE;
576 if (clientCert != GSS_C_NO_BUFFER) {
577 major = duplicateBuffer(minor, clientCert, &newClientCert);
578 if (GSS_ERROR(major))
582 if (privateKey != GSS_C_NO_BUFFER) {
583 major = duplicateBuffer(minor, privateKey, &newPrivateKey);
584 if (GSS_ERROR(major))
588 cred->flags |= CRED_FLAG_CERTIFICATE;
590 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
591 cred->clientCertificate = newClientCert;
593 gss_release_buffer(&tmpMinor, &cred->privateKey);
594 cred->privateKey = newPrivateKey;
596 major = GSS_S_COMPLETE;
600 if (GSS_ERROR(major)) {
601 gss_release_buffer(&tmpMinor, &newClientCert);
602 gss_release_buffer(&tmpMinor, &newPrivateKey);
609 gssEapSetCredService(OM_uint32 *minor,
611 gss_const_name_t target)
613 OM_uint32 major, tmpMinor;
614 gss_name_t newTarget = GSS_C_NO_NAME;
616 if (cred->flags & CRED_FLAG_RESOLVED) {
617 major = GSS_S_FAILURE;
618 *minor = GSSEAP_CRED_RESOLVED;
622 if (target != GSS_C_NO_NAME) {
623 major = gssEapDuplicateName(minor, target, &newTarget);
624 if (GSS_ERROR(major))
627 cred->flags |= CRED_FLAG_TARGET;
629 cred->flags &= ~(CRED_FLAG_TARGET);
632 gssEapReleaseName(&tmpMinor, &cred->target);
633 cred->target = newTarget;
635 major = GSS_S_COMPLETE;
643 gssEapDuplicateCred(OM_uint32 *minor,
644 const gss_cred_id_t src,
647 OM_uint32 major, tmpMinor;
648 gss_cred_id_t dst = GSS_C_NO_CREDENTIAL;
650 *pDst = GSS_C_NO_CREDENTIAL;
652 major = gssEapAllocCred(minor, &dst);
653 if (GSS_ERROR(major))
656 dst->flags = src->flags;
658 if (src->name != GSS_C_NO_NAME) {
659 major = gssEapDuplicateName(minor, src->name, &dst->name);
660 if (GSS_ERROR(major))
664 if (src->target != GSS_C_NO_NAME) {
665 major = gssEapDuplicateName(minor, src->target, &dst->target);
666 if (GSS_ERROR(major))
670 if (src->password.value != NULL) {
671 major = duplicateBuffer(minor, &src->password, &dst->password);
672 if (GSS_ERROR(major))
676 major = duplicateOidSet(minor, src->mechanisms, &dst->mechanisms);
677 if (GSS_ERROR(major))
680 dst->expiryTime = src->expiryTime;
682 if (src->radiusConfigFile.value != NULL)
683 duplicateBufferOrCleanup(&src->radiusConfigFile, &dst->radiusConfigFile);
684 if (src->radiusConfigStanza.value != NULL)
685 duplicateBufferOrCleanup(&src->radiusConfigStanza, &dst->radiusConfigStanza);
686 if (src->caCertificate.value != NULL)
687 duplicateBufferOrCleanup(&src->caCertificate, &dst->caCertificate);
688 if (src->caCertificateBlob.value != NULL)
689 duplicateBufferOrCleanup(&src->caCertificateBlob, &dst->caCertificateBlob);
690 if (src->subjectNameConstraint.value != NULL)
691 duplicateBufferOrCleanup(&src->subjectNameConstraint, &dst->subjectNameConstraint);
692 if (src->subjectAltNameConstraint.value != NULL)
693 duplicateBufferOrCleanup(&src->subjectAltNameConstraint, &dst->subjectAltNameConstraint);
694 if (src->clientCertificate.value != NULL)
695 duplicateBufferOrCleanup(&src->clientCertificate, &dst->clientCertificate);
696 if (src->privateKey.value != NULL)
697 duplicateBufferOrCleanup(&src->privateKey, &dst->privateKey);
699 #ifdef GSSEAP_ENABLE_REAUTH
700 /* XXX krbCredCache, reauthCred */
704 dst = GSS_C_NO_CREDENTIAL;
706 major = GSS_S_COMPLETE;
710 gssEapReleaseCred(&tmpMinor, &dst);
716 staticIdentityFileResolveInitiatorCred(OM_uint32 *minor, gss_cred_id_t cred)
718 OM_uint32 major, tmpMinor;
719 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
720 gss_name_t defaultIdentityName = GSS_C_NO_NAME;
721 gss_buffer_desc defaultPassword = GSS_C_EMPTY_BUFFER;
722 int isDefaultIdentity = FALSE;
724 major = readStaticIdentityFile(minor, &defaultIdentity, &defaultPassword);
725 if (GSS_ERROR(major))
728 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
729 gssEapPrimaryMechForCred(cred), &defaultIdentityName);
730 if (GSS_ERROR(major))
733 if (defaultIdentityName == GSS_C_NO_NAME) {
734 if (cred->name == GSS_C_NO_NAME) {
735 major = GSS_S_CRED_UNAVAIL;
736 *minor = GSSEAP_NO_DEFAULT_IDENTITY;
740 if (cred->name == GSS_C_NO_NAME) {
741 cred->name = defaultIdentityName;
742 defaultIdentityName = GSS_C_NO_NAME;
743 isDefaultIdentity = TRUE;
745 major = gssEapCompareName(minor, cred->name,
746 defaultIdentityName, 0,
748 if (GSS_ERROR(major))
753 if (isDefaultIdentity &&
754 (cred->flags & CRED_FLAG_PASSWORD) == 0) {
755 major = gssEapSetCredPassword(minor, cred, &defaultPassword);
756 if (GSS_ERROR(major))
761 gssEapReleaseName(&tmpMinor, &defaultIdentityName);
762 zeroAndReleasePassword(&defaultPassword);
763 gss_release_buffer(&tmpMinor, &defaultIdentity);
769 gssEapResolveInitiatorCred(OM_uint32 *minor,
770 const gss_cred_id_t cred,
771 gss_const_name_t targetName
772 #ifndef HAVE_MOONSHOT_GET_IDENTITY
776 gss_cred_id_t *pResolvedCred)
778 OM_uint32 major, tmpMinor;
779 gss_cred_id_t resolvedCred = GSS_C_NO_CREDENTIAL;
781 if (cred == GSS_C_NO_CREDENTIAL) {
782 major = gssEapAcquireCred(minor,
790 if (GSS_ERROR(major))
793 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
794 major = GSS_S_NO_CRED;
795 *minor = GSSEAP_CRED_USAGE_MISMATCH;
799 major = gssEapDuplicateCred(minor, cred, &resolvedCred);
800 if (GSS_ERROR(major))
804 if ((resolvedCred->flags & CRED_FLAG_RESOLVED) == 0) {
805 #ifdef HAVE_MOONSHOT_GET_IDENTITY
806 major = libMoonshotResolveInitiatorCred(minor, resolvedCred, targetName);
807 if (major == GSS_S_CRED_UNAVAIL)
809 major = staticIdentityFileResolveInitiatorCred(minor, resolvedCred);
810 if (GSS_ERROR(major) && major != GSS_S_CRED_UNAVAIL)
813 /* If we have a caller-supplied password, the credential is resolved. */
814 if ((resolvedCred->flags &
815 (CRED_FLAG_PASSWORD | CRED_FLAG_CERTIFICATE)) == 0) {
816 major = GSS_S_CRED_UNAVAIL;
817 *minor = GSSEAP_NO_DEFAULT_CRED;
821 resolvedCred->flags |= CRED_FLAG_RESOLVED;
824 *pResolvedCred = resolvedCred;
825 resolvedCred = GSS_C_NO_CREDENTIAL;
827 major = GSS_S_COMPLETE;
831 gssEapReleaseCred(&tmpMinor, &resolvedCred);