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 const gss_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(&desiredName->mutex);
307 major = gssEapDuplicateName(minor, desiredName, &cred->name);
308 if (GSS_ERROR(major)) {
309 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
313 GSSEAP_MUTEX_UNLOCK(&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);
351 * Return TRUE if cred available for mechanism. Caller need no acquire
352 * lock because mechanisms list is immutable.
355 gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech)
360 GSSEAP_ASSERT(mech != GSS_C_NO_OID);
362 if (cred == GSS_C_NO_CREDENTIAL || cred->mechanisms == GSS_C_NO_OID_SET)
365 gss_test_oid_set_member(&minor, mech, cred->mechanisms, &present);
371 staticIdentityFileResolveDefaultIdentity(OM_uint32 *minor,
372 const gss_cred_id_t cred,
375 OM_uint32 major, tmpMinor;
376 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
377 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
379 *pName = GSS_C_NO_NAME;
381 major = readStaticIdentityFile(minor, &defaultIdentity, GSS_C_NO_BUFFER);
382 if (major == GSS_S_COMPLETE) {
383 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
387 gss_release_buffer(&tmpMinor, &defaultIdentity);
393 gssEapResolveCredIdentity(OM_uint32 *minor,
397 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
399 if (cred->name != GSS_C_NO_NAME) {
401 return GSS_S_COMPLETE;
404 if (cred->flags & CRED_FLAG_ACCEPT) {
405 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
406 char serviceName[5 + MAXHOSTNAMELEN];
408 /* default host-based service is host@localhost */
409 memcpy(serviceName, "host@", 5);
410 if (gethostname(&serviceName[5], MAXHOSTNAMELEN) != 0) {
411 *minor = GSSEAP_NO_HOSTNAME;
412 return GSS_S_FAILURE;
415 nameBuf.value = serviceName;
416 nameBuf.length = strlen((char *)nameBuf.value);
418 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_HOSTBASED_SERVICE,
419 nameMech, &cred->name);
420 if (GSS_ERROR(major))
422 } else if (cred->flags & CRED_FLAG_INITIATE) {
423 #ifdef HAVE_MOONSHOT_GET_IDENTITY
424 major = libMoonshotResolveDefaultIdentity(minor, cred, &cred->name);
425 if (major == GSS_S_CRED_UNAVAIL)
427 major = staticIdentityFileResolveDefaultIdentity(minor, cred, &cred->name);
428 if (major != GSS_S_CRED_UNAVAIL)
433 return GSS_S_COMPLETE;
437 gssEapInquireCred(OM_uint32 *minor,
440 OM_uint32 *pLifetime,
441 gss_cred_usage_t *cred_usage,
442 gss_OID_set *mechanisms)
445 time_t now, lifetime;
448 major = gssEapResolveCredIdentity(minor, cred);
449 if (GSS_ERROR(major))
452 if (cred->name != GSS_C_NO_NAME) {
453 major = gssEapDuplicateName(minor, cred->name, name);
454 if (GSS_ERROR(major))
457 *name = GSS_C_NO_NAME;
460 if (cred_usage != NULL) {
461 OM_uint32 flags = (cred->flags & (CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT));
464 case CRED_FLAG_INITIATE:
465 *cred_usage = GSS_C_INITIATE;
467 case CRED_FLAG_ACCEPT:
468 *cred_usage = GSS_C_ACCEPT;
471 *cred_usage = GSS_C_BOTH;
476 if (mechanisms != NULL) {
477 if (cred->mechanisms != GSS_C_NO_OID_SET)
478 major = duplicateOidSet(minor, cred->mechanisms, mechanisms);
480 major = gssEapIndicateMechs(minor, mechanisms);
481 if (GSS_ERROR(major))
485 if (cred->expiryTime == 0) {
486 lifetime = GSS_C_INDEFINITE;
489 lifetime = now - cred->expiryTime;
494 if (pLifetime != NULL) {
495 *pLifetime = lifetime;
499 major = GSS_S_CREDENTIALS_EXPIRED;
500 *minor = GSSEAP_CRED_EXPIRED;
504 major = GSS_S_COMPLETE;
512 gssEapSetCredPassword(OM_uint32 *minor,
514 const gss_buffer_t password)
516 OM_uint32 major, tmpMinor;
517 gss_buffer_desc newPassword = GSS_C_EMPTY_BUFFER;
519 if (cred->flags & CRED_FLAG_RESOLVED) {
520 major = GSS_S_FAILURE;
521 *minor = GSSEAP_CRED_RESOLVED;
525 if (password != GSS_C_NO_BUFFER) {
526 major = duplicateBuffer(minor, password, &newPassword);
527 if (GSS_ERROR(major))
530 cred->flags |= CRED_FLAG_PASSWORD;
532 cred->flags &= ~(CRED_FLAG_PASSWORD);
535 gss_release_buffer(&tmpMinor, &cred->password);
536 cred->password = newPassword;
538 major = GSS_S_COMPLETE;
546 * Currently only the privateKey path is exposed to the application
547 * (via gss_set_cred_option() or the third line in ~/.gss_eap_id).
548 * At some point in the future we may add support for setting the
549 * client certificate separately.
552 gssEapSetCredClientCertificate(OM_uint32 *minor,
554 const gss_buffer_t clientCert,
555 const gss_buffer_t privateKey)
557 OM_uint32 major, tmpMinor;
558 gss_buffer_desc newClientCert = GSS_C_EMPTY_BUFFER;
559 gss_buffer_desc newPrivateKey = GSS_C_EMPTY_BUFFER;
561 if (cred->flags & CRED_FLAG_RESOLVED) {
562 major = GSS_S_FAILURE;
563 *minor = GSSEAP_CRED_RESOLVED;
567 if (clientCert == GSS_C_NO_BUFFER &&
568 privateKey == GSS_C_NO_BUFFER) {
569 cred->flags &= ~(CRED_FLAG_CERTIFICATE);
570 major = GSS_S_COMPLETE;
575 if (clientCert != GSS_C_NO_BUFFER) {
576 major = duplicateBuffer(minor, clientCert, &newClientCert);
577 if (GSS_ERROR(major))
581 if (privateKey != GSS_C_NO_BUFFER) {
582 major = duplicateBuffer(minor, privateKey, &newPrivateKey);
583 if (GSS_ERROR(major))
587 cred->flags |= CRED_FLAG_CERTIFICATE;
589 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
590 cred->clientCertificate = newClientCert;
592 gss_release_buffer(&tmpMinor, &cred->privateKey);
593 cred->privateKey = newPrivateKey;
595 major = GSS_S_COMPLETE;
599 if (GSS_ERROR(major)) {
600 gss_release_buffer(&tmpMinor, &newClientCert);
601 gss_release_buffer(&tmpMinor, &newPrivateKey);
608 gssEapSetCredService(OM_uint32 *minor,
610 const gss_name_t target)
612 OM_uint32 major, tmpMinor;
613 gss_name_t newTarget = GSS_C_NO_NAME;
615 if (cred->flags & CRED_FLAG_RESOLVED) {
616 major = GSS_S_FAILURE;
617 *minor = GSSEAP_CRED_RESOLVED;
621 if (target != GSS_C_NO_NAME) {
622 major = gssEapDuplicateName(minor, target, &newTarget);
623 if (GSS_ERROR(major))
626 cred->flags |= CRED_FLAG_TARGET;
628 cred->flags &= ~(CRED_FLAG_TARGET);
631 gssEapReleaseName(&tmpMinor, &cred->target);
632 cred->target = newTarget;
634 major = GSS_S_COMPLETE;
642 gssEapDuplicateCred(OM_uint32 *minor,
643 const gss_cred_id_t src,
646 OM_uint32 major, tmpMinor;
647 gss_cred_id_t dst = GSS_C_NO_CREDENTIAL;
649 *pDst = GSS_C_NO_CREDENTIAL;
651 major = gssEapAllocCred(minor, &dst);
652 if (GSS_ERROR(major))
655 dst->flags = src->flags;
657 if (src->name != GSS_C_NO_NAME) {
658 major = gssEapDuplicateName(minor, src->name, &dst->name);
659 if (GSS_ERROR(major))
663 if (src->target != GSS_C_NO_NAME) {
664 major = gssEapDuplicateName(minor, src->target, &dst->target);
665 if (GSS_ERROR(major))
669 if (src->password.value != NULL) {
670 major = duplicateBuffer(minor, &src->password, &dst->password);
671 if (GSS_ERROR(major))
675 major = duplicateOidSet(minor, src->mechanisms, &dst->mechanisms);
676 if (GSS_ERROR(major))
679 dst->expiryTime = src->expiryTime;
681 if (src->radiusConfigFile.value != NULL)
682 duplicateBufferOrCleanup(&src->radiusConfigFile, &dst->radiusConfigFile);
683 if (src->radiusConfigStanza.value != NULL)
684 duplicateBufferOrCleanup(&src->radiusConfigStanza, &dst->radiusConfigStanza);
685 if (src->caCertificate.value != NULL)
686 duplicateBufferOrCleanup(&src->caCertificate, &dst->caCertificate);
687 if (src->caCertificateBlob.value != NULL)
688 duplicateBufferOrCleanup(&src->caCertificateBlob, &dst->caCertificateBlob);
689 if (src->subjectNameConstraint.value != NULL)
690 duplicateBufferOrCleanup(&src->subjectNameConstraint, &dst->subjectNameConstraint);
691 if (src->subjectAltNameConstraint.value != NULL)
692 duplicateBufferOrCleanup(&src->subjectAltNameConstraint, &dst->subjectAltNameConstraint);
693 if (src->clientCertificate.value != NULL)
694 duplicateBufferOrCleanup(&src->clientCertificate, &dst->clientCertificate);
695 if (src->privateKey.value != NULL)
696 duplicateBufferOrCleanup(&src->privateKey, &dst->privateKey);
698 #ifdef GSSEAP_ENABLE_REAUTH
699 /* XXX krbCredCache, reauthCred */
703 dst = GSS_C_NO_CREDENTIAL;
705 major = GSS_S_COMPLETE;
709 gssEapReleaseCred(&tmpMinor, &dst);
715 staticIdentityFileResolveInitiatorCred(OM_uint32 *minor, gss_cred_id_t cred)
717 OM_uint32 major, tmpMinor;
718 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
719 gss_name_t defaultIdentityName = GSS_C_NO_NAME;
720 gss_buffer_desc defaultPassword = GSS_C_EMPTY_BUFFER;
721 int isDefaultIdentity = FALSE;
723 major = readStaticIdentityFile(minor, &defaultIdentity, &defaultPassword);
724 if (GSS_ERROR(major))
727 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
728 gssEapPrimaryMechForCred(cred), &defaultIdentityName);
729 if (GSS_ERROR(major))
732 if (defaultIdentityName == GSS_C_NO_NAME) {
733 if (cred->name == GSS_C_NO_NAME) {
734 major = GSS_S_CRED_UNAVAIL;
735 *minor = GSSEAP_NO_DEFAULT_IDENTITY;
739 if (cred->name == GSS_C_NO_NAME) {
740 cred->name = defaultIdentityName;
741 defaultIdentityName = GSS_C_NO_NAME;
742 isDefaultIdentity = TRUE;
744 major = gssEapCompareName(minor, cred->name,
745 defaultIdentityName, 0,
747 if (GSS_ERROR(major))
752 if (isDefaultIdentity &&
753 (cred->flags & CRED_FLAG_PASSWORD) == 0) {
754 major = gssEapSetCredPassword(minor, cred, &defaultPassword);
755 if (GSS_ERROR(major))
760 gssEapReleaseName(&tmpMinor, &defaultIdentityName);
761 zeroAndReleasePassword(&defaultPassword);
762 gss_release_buffer(&tmpMinor, &defaultIdentity);
768 gssEapResolveInitiatorCred(OM_uint32 *minor,
769 const gss_cred_id_t cred,
770 const gss_name_t targetName
771 #ifndef HAVE_MOONSHOT_GET_IDENTITY
775 gss_cred_id_t *pResolvedCred)
777 OM_uint32 major, tmpMinor;
778 gss_cred_id_t resolvedCred = GSS_C_NO_CREDENTIAL;
780 if (cred == GSS_C_NO_CREDENTIAL) {
781 major = gssEapAcquireCred(minor,
789 if (GSS_ERROR(major))
792 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
793 major = GSS_S_NO_CRED;
794 *minor = GSSEAP_CRED_USAGE_MISMATCH;
798 major = gssEapDuplicateCred(minor, cred, &resolvedCred);
799 if (GSS_ERROR(major))
803 if ((resolvedCred->flags & CRED_FLAG_RESOLVED) == 0) {
804 #ifdef HAVE_MOONSHOT_GET_IDENTITY
805 major = libMoonshotResolveInitiatorCred(minor, resolvedCred, targetName);
806 if (major == GSS_S_CRED_UNAVAIL)
808 major = staticIdentityFileResolveInitiatorCred(minor, resolvedCred);
809 if (GSS_ERROR(major) && major != GSS_S_CRED_UNAVAIL)
812 /* If we have a caller-supplied password, the credential is resolved. */
813 if ((resolvedCred->flags &
814 (CRED_FLAG_PASSWORD | CRED_FLAG_CERTIFICATE)) == 0) {
815 major = GSS_S_CRED_UNAVAIL;
816 *minor = GSSEAP_NO_DEFAULT_CRED;
820 resolvedCred->flags |= CRED_FLAG_RESOLVED;
823 *pResolvedCred = resolvedCred;
824 resolvedCred = GSS_C_NO_CREDENTIAL;
826 major = GSS_S_COMPLETE;
830 gssEapReleaseCred(&tmpMinor, &resolvedCred);