cleanup and plugin attr context creation
[mech_eap.orig] / util_shib.cpp
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  * Copyright 2001-2009 Internet2
34  * 
35  * Licensed under the Apache License, Version 2.0 (the "License");
36  * you may not use this file except in compliance with the License.
37  * You may obtain a copy of the License at
38  *
39  *     http://www.apache.org/licenses/LICENSE-2.0
40  *
41  * Unless required by applicable law or agreed to in writing, software
42  * distributed under the License is distributed on an "AS IS" BASIS,
43  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
44  * See the License for the specific language governing permissions and
45  * limitations under the License.
46  */
47
48 #include "gssapiP_eap.h"
49
50 #include <shibsp/Application.h>
51 #include <shibsp/exceptions.h>
52 #include <shibsp/SPConfig.h>
53 #include <shibsp/ServiceProvider.h>
54 #include <shibsp/attribute/Attribute.h>
55 #include <shibsp/attribute/SimpleAttribute.h>
56 #include <shibsp/attribute/resolver/ResolutionContext.h>
57 #include <shibsp/handler/AssertionConsumerService.h>
58 #include <shibsp/metadata/MetadataProviderCriteria.h>
59 #include <shibsp/util/SPConstants.h>
60
61 #include <saml/saml1/core/Assertions.h>
62 #include <saml/saml2/core/Assertions.h>
63 #include <saml/saml2/metadata/Metadata.h>
64 #include <xercesc/util/XMLUniDefs.hpp>
65 #include <xmltooling/XMLToolingConfig.h>
66 #include <xmltooling/util/XMLHelper.h>
67
68 #include "resolver.h"
69
70 using namespace shibsp;
71 using namespace shibresolver;
72 using namespace opensaml::saml2md;
73 using namespace opensaml;
74 using namespace xmltooling::logging;
75 using namespace xmltooling;
76 using namespace xercesc;
77 using namespace std;
78
79 gss_eap_shib_attr_provider::gss_eap_shib_attr_provider(void)
80 {
81     m_authenticated = false;
82 }
83
84 gss_eap_shib_attr_provider::~gss_eap_shib_attr_provider(void)
85 {
86     for_each(m_attributes.begin(),
87              m_attributes.end(),
88              xmltooling::cleanup<Attribute>())
89         ;
90 }
91
92 bool
93 gss_eap_shib_attr_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
94                                                     const gss_eap_attr_provider *ctx)
95 {
96     const gss_eap_shib_attr_provider *shib;
97
98     if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx)) {
99         return false;
100     }
101
102     m_authenticated = false;
103
104     shib = static_cast<const gss_eap_shib_attr_provider *>(ctx);
105     if (shib != NULL) {
106         m_attributes = duplicateAttributes(shib->getAttributes());
107         m_authenticated = shib->authenticated();
108     }
109
110     return true;
111 }
112
113 bool
114 addRadiusAttribute(const gss_eap_attr_provider *provider,
115                    const gss_buffer_t attribute,
116                    void *data)
117 {
118     const gss_eap_shib_attr_provider *shib;
119     const gss_eap_radius_attr_provider *radius;
120     int authenticated, complete, more = -1;
121     vector <string> attributeIds(1);
122     SimpleAttribute *a;
123
124     radius = static_cast<const gss_eap_radius_attr_provider *>(provider);
125     shib = static_cast<const gss_eap_shib_attr_provider *>(data);
126
127     assert(radius != NULL && shib != NULL);
128
129     string attributeName =
130         gss_eap_attr_ctx::composeAttributeName(ATTR_TYPE_RADIUS, attribute);
131
132     attributeIds.push_back(attributeName);
133     a = new SimpleAttribute(attributeIds);
134     if (a == NULL)
135         return false;
136
137     while (more != 0) {
138         gss_buffer_desc value = GSS_C_EMPTY_BUFFER;
139         OM_uint32 minor;
140
141         if (!radius->getAttribute(attribute,
142                                   &authenticated,
143                                   &complete,
144                                   &value,
145                                   NULL,
146                                   &more))
147             return false;
148
149         string attributeValue((char *)value.value, value.length);
150         a->getValues().push_back(attributeValue);
151
152         gss_release_buffer(&minor, &value);
153     }
154
155     shib->getAttributes().push_back(a);
156
157     return true;
158 }
159
160 bool
161 gss_eap_shib_attr_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
162                                                const gss_cred_id_t gssCred,
163                                                const gss_ctx_id_t gssCtx)
164 {
165     const gss_eap_saml_assertion_provider *saml;
166     const gss_eap_radius_attr_provider *radius;
167     gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
168     ShibbolethResolver *resolver = NULL;
169     OM_uint32 minor;
170
171     if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
172         return false;
173
174     saml = static_cast<const gss_eap_saml_assertion_provider *>
175         (manager->getProvider(ATTR_TYPE_SAML_ASSERTION));
176     radius = static_cast<const gss_eap_radius_attr_provider *>
177         (manager->getProvider(ATTR_TYPE_RADIUS));
178
179     if (gssCred != GSS_C_NO_CREDENTIAL &&
180         gss_display_name(&minor, gssCred->name, &nameBuf, NULL) == GSS_S_COMPLETE)
181         resolver->setApplicationID((const char *)nameBuf.value);
182
183     m_authenticated = false;
184
185     if (radius != NULL) {
186         radius->getAttributeTypes(addRadiusAttribute, (void *)this);
187         m_authenticated = radius->authenticated();
188     }
189
190     if (saml != NULL && saml->getAssertion() != NULL) {
191         resolver->addToken(saml->getAssertion());
192         if (m_authenticated)
193             m_authenticated = saml->authenticated();
194     }
195
196     resolver->resolveAttributes(m_attributes);
197
198     gss_release_buffer(&minor, &nameBuf);
199
200     delete resolver;
201
202     return true;
203 }
204
205 int
206 gss_eap_shib_attr_provider::getAttributeIndex(const gss_buffer_t attr) const
207 {
208     int i = 0;
209
210     for (vector<Attribute *>::const_iterator a = m_attributes.begin();
211          a != m_attributes.end();
212          ++a)
213     {
214         for (vector<string>::const_iterator s = (*a)->getAliases().begin();
215              s != (*a)->getAliases().end();
216              ++s) {
217             if (attr->length == (*s).length() &&
218                 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
219                 return i;
220             }
221         }
222     }
223
224     return -1;
225 }
226
227 void
228 gss_eap_shib_attr_provider::setAttribute(int complete,
229                                          const gss_buffer_t attr,
230                                          const gss_buffer_t value)
231 {
232     string attrStr((char *)attr->value, attr->length);
233     vector <string> ids(1);
234
235     ids.push_back(attrStr);
236
237     SimpleAttribute *a = new SimpleAttribute(ids);
238
239     if (value->length != 0) {
240         string valueStr((char *)value->value, value->length);
241
242         a->getValues().push_back(valueStr);        
243     }
244
245     m_attributes.push_back(a);
246     m_authenticated = false;
247 }
248
249 void
250 gss_eap_shib_attr_provider::deleteAttribute(const gss_buffer_t attr)
251 {
252     int i;
253
254     i = getAttributeIndex(attr);
255     if (i >= 0)
256         m_attributes.erase(m_attributes.begin() + i);
257
258     m_authenticated = false;
259 }
260
261 bool
262 gss_eap_shib_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
263                                               void *data) const
264 {
265     for (vector<Attribute*>::const_iterator a = m_attributes.begin();
266         a != m_attributes.end();
267         ++a)
268     {
269         gss_buffer_desc attribute;
270
271         attribute.value = (void *)((*a)->getId());
272         attribute.length = strlen((char *)attribute.value);
273
274         if (!addAttribute(this, &attribute, data))
275             return false;
276     }
277
278     return true;
279 }
280
281 const Attribute *
282 gss_eap_shib_attr_provider::getAttribute(const gss_buffer_t attr) const
283 {
284     const Attribute *ret = NULL;
285
286     for (vector<Attribute *>::const_iterator a = m_attributes.begin();
287          a != m_attributes.end();
288          ++a)
289     {
290         for (vector<string>::const_iterator s = (*a)->getAliases().begin();
291              s != (*a)->getAliases().end();
292              ++s) {
293             if (attr->length == (*s).length() &&
294                 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
295                 ret = *a;
296                 break;
297             }
298         }
299         if (ret != NULL)
300             break;
301     }
302
303     return ret;
304 }
305
306 bool
307 gss_eap_shib_attr_provider::getAttribute(const gss_buffer_t attr,
308                                          int *authenticated,
309                                          int *complete,
310                                          gss_buffer_t value,
311                                          gss_buffer_t display_value,
312                                          int *more) const
313 {
314     const Attribute *shibAttr = NULL;
315     gss_buffer_desc buf;
316     int nvalues, i = *more;
317
318     *more = 0;
319
320     shibAttr = getAttribute(attr);
321     if (shibAttr == NULL)
322         return false;
323
324     nvalues = shibAttr->valueCount();
325
326     if (i == -1)
327         i = 0;
328     else if (i >= nvalues)
329         return false;
330
331     buf.value = (void *)shibAttr->getString(*more);
332     buf.length = strlen((char *)buf.value);
333
334     if (buf.length != 0) {
335         if (value != NULL)
336             duplicateBuffer(buf, value);
337
338         if (display_value != NULL)
339             duplicateBuffer(buf, display_value);
340     }
341
342     if (authenticated != NULL) 
343         *authenticated = m_authenticated;
344     if (complete != NULL)
345         *complete = false;
346
347     if (nvalues > ++i)
348         *more = i;
349
350     return true;
351 }
352
353 gss_any_t
354 gss_eap_shib_attr_provider::mapToAny(int authenticated,
355                                      gss_buffer_t type_id) const
356 {
357     gss_any_t output;
358
359     vector <Attribute *>v = duplicateAttributes(m_attributes);
360
361     output = (gss_any_t)new vector <Attribute *>(v);
362
363     return output;
364 }
365
366 void
367 gss_eap_shib_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id,
368                                                   gss_any_t input) const
369 {
370     vector <Attribute *> *v = ((vector <Attribute *> *)input);
371     delete v;
372 }
373
374 void
375 gss_eap_shib_attr_provider::exportToBuffer(gss_buffer_t buffer) const
376 {
377     DDF obj(NULL);
378     DDF attrs(NULL);
379
380     buffer->length = 0;
381     buffer->value = NULL;
382
383     obj.addmember("version").integer(1);
384     obj.addmember("authenticated").integer(m_authenticated);
385
386     attrs = obj.addmember("attributes").list();
387     for (vector<Attribute*>::const_iterator a = m_attributes.begin();
388          a != m_attributes.end(); ++a) {
389         DDF attr = (*a)->marshall();
390         attrs.add(attr);
391     }
392
393     ostringstream sink;
394     sink << attrs;
395     string str = sink.str();
396
397     duplicateBuffer(str, buffer);
398
399     attrs.destroy();
400 }
401
402 bool
403 gss_eap_shib_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
404                                            const gss_buffer_t buffer)
405 {
406     if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
407         return false;
408
409     if (buffer->length == 0)
410         return true;
411
412     assert(m_authenticated == false);
413     assert(m_attributes.size() == 0);
414
415     DDF obj(NULL);
416     string str((const char *)buffer->value, buffer->length);
417     istringstream source(str);
418
419     source >> obj;
420
421     if (obj["version"].integer() != 1)
422         return false;
423
424     m_authenticated = (obj["authenticated"].integer() != 0);
425
426     DDF attrs = obj["attributes"];
427     DDF attr = attrs.first();
428     while (!attr.isnull()) {
429         Attribute *attribute = Attribute::unmarshall(attr);
430         m_attributes.push_back(attribute);
431         attr = attrs.next();
432     }
433
434     attrs.destroy();
435
436     return true;
437 }
438
439 bool
440 gss_eap_shib_attr_provider::init(void)
441 {
442     if (!ShibbolethResolver::init())
443         return false;
444
445     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_LOCAL,
446                                        NULL,
447                                        gss_eap_shib_attr_provider::createAttrContext);
448
449     return true;
450 }
451
452 void
453 gss_eap_shib_attr_provider::finalize(void)
454 {
455     ShibbolethResolver::term();
456     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_LOCAL);
457 }
458
459 gss_eap_attr_provider *
460 gss_eap_shib_attr_provider::createAttrContext(void)
461 {
462     return new gss_eap_shib_attr_provider;
463 }
464
465 Attribute *
466 gss_eap_shib_attr_provider::duplicateAttribute(const Attribute *src)
467 {
468     Attribute *attribute;
469
470     DDF obj = src->marshall();
471     attribute = Attribute::unmarshall(obj);
472     obj.destroy();
473
474     return attribute;
475 }
476
477 vector <Attribute *>
478 gss_eap_shib_attr_provider::duplicateAttributes(const vector <Attribute *>src)
479 {
480     vector <Attribute *> dst;
481
482     for (vector<Attribute *>::const_iterator a = src.begin();
483          a != src.end();
484          ++a)
485         dst.push_back(duplicateAttribute(*a));
486
487     return dst;
488 }