Merge branch 'master' of ssh://moonshot.suchdamage.org:822/srv/git/moonshot
[mech_eap.orig] / util_mech.c
1 /*
2  * Copyright (c) 2010, JANET(UK)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
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.
15  *
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.
19  *
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
30  * SUCH DAMAGE.
31  */
32
33 /*
34  * General mechanism utility routines.
35  */
36
37 #include "gssapiP_eap.h"
38
39 /*
40  * 1.3.6.1.4.1.5322(padl)
41  *      gssEap(22)
42  *       mechanisms(1)
43  *        eap-aes128-cts-hmac-sha1-96(17)
44  *        eap-aes256-cts-hmac-sha1-96(18)
45  *       nameTypes(2)
46  *       apiExtensions(3)
47  *        inquireSecContextByOid(1)
48  *        inquireCredByOid(2)
49  *        setSecContextOption(3)
50  *        setCredOption(4)
51  *        mechInvoke(5)
52  */
53
54 /*
55  * Note: the enctype-less OID is used as the mechanism OID in exported
56  * names. There is no public symbol for it. This is consistent with
57  * the krb5 mechanism which, whilst known by many OIDs, always uses a
58  * canonical OID for exported names. (This OID is also returned by
59  * gss_inquire_name.)
60  */
61 static gss_OID_desc gssEapMechOids[] = {
62     /* 1.3.6.1.4.1.5322.22.1  */
63     { 9, "\x2B\x06\x01\x04\x01\xA9\x4A\x16\x01" },
64     /* 1.3.6.1.4.1.5322.22.1.17 */
65     { 10, "\x2B\x06\x01\x04\x01\xA9\x4A\x16\x01\x11" },
66     /* 1.3.6.1.4.1.5322.22.1.18 */
67     { 10, "\x2B\x06\x01\x04\x01\xA9\x4A\x16\x01\x12" }
68 };
69
70 gss_OID GSS_EAP_MECHANISM                            = &gssEapMechOids[0];
71 gss_OID GSS_EAP_AES128_CTS_HMAC_SHA1_96_MECHANISM    = &gssEapMechOids[1];
72 gss_OID GSS_EAP_AES256_CTS_HMAC_SHA1_96_MECHANISM    = &gssEapMechOids[2];
73
74 /*
75  * Returns TRUE is the OID is a concrete mechanism OID, that is, one
76  * with a Kerberos enctype as the last element.
77  */
78 int
79 gssEapIsConcreteMechanismOid(const gss_OID oid)
80 {
81     return oid->length > GSS_EAP_MECHANISM->length &&
82            memcmp(oid->elements, GSS_EAP_MECHANISM->elements,
83                   GSS_EAP_MECHANISM->length) == 0;
84 }
85
86 int
87 gssEapIsMechanismOid(const gss_OID oid)
88 {
89     return oid == GSS_C_NO_OID ||
90            oidEqual(oid, GSS_EAP_MECHANISM) ||
91            gssEapIsConcreteMechanismOid(oid);
92 }
93
94 /*
95  * Validate that all elements are concrete mechanism OIDs.
96  */
97 OM_uint32
98 gssEapValidateMechs(OM_uint32 *minor,
99                     const gss_OID_set mechs)
100 {
101     int i;
102
103     *minor = 0;
104
105     if (mechs == GSS_C_NO_OID_SET) {
106         return GSS_S_COMPLETE;
107     }
108
109     for (i = 0; i < mechs->count; i++) {
110         gss_OID oid = &mechs->elements[i];
111
112         if (!gssEapIsConcreteMechanismOid(oid)) {
113             *minor = GSSEAP_WRONG_MECH;
114             return GSS_S_BAD_MECH;
115         }
116     }
117
118     return GSS_S_COMPLETE;
119 }
120
121 OM_uint32
122 gssEapOidToEnctype(OM_uint32 *minor,
123                    const gss_OID oid,
124                    krb5_enctype *enctype)
125 {
126     OM_uint32 major;
127     int suffix;
128
129     major = decomposeOid(minor,
130                          GSS_EAP_MECHANISM->elements,
131                          GSS_EAP_MECHANISM->length,
132                          oid,
133                          &suffix);
134     if (major == GSS_S_COMPLETE)
135         *enctype = suffix;
136
137     return major;
138 }
139
140 OM_uint32
141 gssEapEnctypeToOid(OM_uint32 *minor,
142                    krb5_enctype enctype,
143                    gss_OID *pOid)
144 {
145     OM_uint32 major;
146     gss_OID oid;
147
148     *pOid = NULL;
149
150     oid = (gss_OID)GSSEAP_MALLOC(sizeof(*oid));
151     if (oid == NULL) {
152         *minor = ENOMEM;
153         return GSS_S_FAILURE;
154     }
155
156     oid->length = GSS_EAP_MECHANISM->length + 1;
157     oid->elements = GSSEAP_MALLOC(oid->length);
158     if (oid->elements == NULL) {
159         *minor = ENOMEM;
160         GSSEAP_FREE(oid);
161         return GSS_S_FAILURE;
162     }
163
164     major = composeOid(minor,
165                        GSS_EAP_MECHANISM->elements,
166                        GSS_EAP_MECHANISM->length,
167                        enctype,
168                        oid);
169     if (major == GSS_S_COMPLETE) {
170         gssEapInternalizeOid(oid, pOid);
171         *pOid = oid;
172     } else {
173         GSSEAP_FREE(oid->elements);
174         GSSEAP_FREE(oid);
175     }
176
177     return major;
178 }
179
180 OM_uint32
181 gssEapIndicateMechs(OM_uint32 *minor,
182                     gss_OID_set *mechs)
183 {
184     krb5_context krbContext;
185     OM_uint32 major, tmpMinor;
186     krb5_enctype *etypes;
187     int i;
188
189     GSSEAP_KRB_INIT(&krbContext);
190
191     *minor = krb5_get_permitted_enctypes(krbContext, &etypes);
192     if (*minor != 0) {
193         return GSS_S_FAILURE;
194     }
195
196     major = gss_create_empty_oid_set(minor, mechs);
197     if (GSS_ERROR(major)) {
198         GSSEAP_FREE(etypes);
199         return major;
200     }
201
202     for (i = 0; etypes[i] != ENCTYPE_NULL; i++) {
203         gss_OID mechOid;
204
205         /* XXX currently we aren't equipped to encode these enctypes */
206         if (etypes[i] < 0 || etypes[i] > 127)
207             continue;
208
209         major = gssEapEnctypeToOid(minor, etypes[i], &mechOid);
210         if (GSS_ERROR(major))
211             break;
212
213         major = gss_add_oid_set_member(minor, mechOid, mechs);
214         if (GSS_ERROR(major))
215             break;
216
217         gss_release_oid(&tmpMinor, &mechOid);
218     }
219
220     GSSEAP_FREE(etypes);
221
222     *minor = 0;
223     return major;
224 }
225
226 OM_uint32
227 gssEapDefaultMech(OM_uint32 *minor,
228                   gss_OID *oid)
229 {
230     gss_OID_set mechs;
231     OM_uint32 major, tmpMinor;
232
233     major = gssEapIndicateMechs(minor, &mechs);
234     if (GSS_ERROR(major)) {
235         return major;
236     }
237
238     if (mechs->count == 0) {
239         gss_release_oid_set(&tmpMinor, &mechs);
240         return GSS_S_BAD_MECH;
241     }
242
243     if (!gssEapInternalizeOid(&mechs->elements[0], oid)) {
244         /* don't double-free if we didn't internalize it */
245         mechs->elements[0].length = 0;
246         mechs->elements[0].elements = NULL;
247     }
248
249     gss_release_oid_set(&tmpMinor, &mechs);
250
251     *minor = 0;
252     return GSS_S_COMPLETE;
253 }
254
255 int
256 gssEapInternalizeOid(const gss_OID oid,
257                      gss_OID *const pInternalizedOid)
258 {
259     int i;
260
261     *pInternalizedOid = GSS_C_NO_OID;
262
263     for (i = 0;
264          i < sizeof(gssEapMechOids) / sizeof(gssEapMechOids[0]);
265          i++) {
266         if (oidEqual(oid, &gssEapMechOids[i])) {
267             *pInternalizedOid = (const gss_OID)&gssEapMechOids[i];
268             break;
269         }
270     }
271
272     if (*pInternalizedOid == GSS_C_NO_OID) {
273         if (oidEqual(oid, GSS_EAP_NT_PRINCIPAL_NAME))
274             *pInternalizedOid = (const gss_OID)GSS_EAP_NT_PRINCIPAL_NAME;
275     }
276
277     if (*pInternalizedOid == GSS_C_NO_OID) {
278         *pInternalizedOid = oid;
279         return 0;
280     }
281
282     return 1;
283 }
284
285 OM_uint32
286 gssEapReleaseOid(OM_uint32 *minor, gss_OID *oid)
287 {
288     gss_OID internalizedOid = GSS_C_NO_OID;
289
290     *minor = 0;
291
292     if (gssEapInternalizeOid(*oid, &internalizedOid)) {
293         /* OID was internalized, so we can mark it as "freed" */
294         *oid = GSS_C_NO_OID;
295         return GSS_S_COMPLETE;
296     }
297
298     /* we don't know about this OID */
299     return GSS_S_CONTINUE_NEEDED;
300 }
301
302 static gss_buffer_desc gssEapSaslMechs[] = {
303     { sizeof("EAP") - 1,        "EAP",       }, /* not used */
304     { sizeof("EAP-AES128") - 1, "EAP-AES128" },
305     { sizeof("EAP-AES256") - 1, "EAP-AES256" },
306 };
307
308 gss_buffer_t
309 gssEapOidToSaslName(const gss_OID oid)
310 {
311     size_t i;
312
313     for (i = 1; i < sizeof(gssEapMechOids)/sizeof(gssEapMechOids[0]); i++) {
314         if (oidEqual(&gssEapMechOids[i], oid))
315             return &gssEapSaslMechs[i];
316     }
317
318     return GSS_C_NO_BUFFER;
319 }
320
321 gss_OID
322 gssEapSaslNameToOid(const gss_buffer_t name)
323 {
324     size_t i;
325
326     for (i = 1; i < sizeof(gssEapSaslMechs)/sizeof(gssEapSaslMechs[0]); i++) {
327         if (bufferEqual(&gssEapSaslMechs[i], name))
328             return &gssEapMechOids[i];
329     }
330
331     return GSS_C_NO_OID;
332 }