mech_eap/util_shib.cpp

   1 /*
   2  * Copyright (c) 2011, 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 /*
  49  * Local attribute provider implementation.
  50  */
  51
  52 #include <xmltooling/XMLObject.h>
  53
  54 #include <saml/saml2/core/Assertions.h>
  55
  56 #include <shibsp/exceptions.h>
  57 #include <shibsp/attribute/SimpleAttribute.h>
  58 #include <shibresolver/resolver.h>
  59
  60 #include <sstream>
  61
  62 #include "gssapiP_eap.h"
  63
  64 using namespace shibsp;
  65 using namespace shibresolver;
  66 using namespace opensaml::saml2md;
  67 using namespace opensaml;
  68 using namespace xmltooling;
  69 using namespace std;
  70
  71 gss_eap_shib_attr_provider::gss_eap_shib_attr_provider(void)
  72 {
  73     m_initialized = false;
  74     m_authenticated = false;
  75 }
  76
  77 gss_eap_shib_attr_provider::~gss_eap_shib_attr_provider(void)
  78 {
  79     for_each(m_attributes.begin(),
  80              m_attributes.end(),
  81              xmltooling::cleanup<Attribute>())
  82         ;
  83 }
  84
  85 bool
  86 gss_eap_shib_attr_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
  87                                                     const gss_eap_attr_provider *ctx)
  88 {
  89     const gss_eap_shib_attr_provider *shib;
  90
  91     if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx)) {
  92         return false;
  93     }
  94
  95     m_authenticated = false;
  96
  97     shib = static_cast<const gss_eap_shib_attr_provider *>(ctx);
  98     if (shib != NULL) {
  99         m_attributes = duplicateAttributes(shib->getAttributes());
 100         m_authenticated = shib->authenticated();
 101     }
 102
 103     m_initialized = true;
 104
 105     return true;
 106 }
 107
 108 bool
 109 gss_eap_shib_attr_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
 110                                                const gss_cred_id_t gssCred,
 111                                                const gss_ctx_id_t gssCtx)
 112 {
 113     const gss_eap_saml_assertion_provider *saml;
 114     gss_buffer_desc exportedCtx = GSS_C_EMPTY_BUFFER;
 115     OM_uint32 major, minor;
 116 #if 0
 117     gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
 118 #endif
 119
 120     if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
 121         return false;
 122
 123     saml = static_cast<const gss_eap_saml_assertion_provider *>
 124         (m_manager->getProvider(ATTR_TYPE_SAML_ASSERTION));
 125
 126     auto_ptr<ShibbolethResolver> resolver(ShibbolethResolver::create());
 127
 128     /*
 129      * For now, leave ApplicationID defaulted.
 130      * Later on, we could allow this via config option to the mechanism
 131      * or rely on an SPRequest interface to pass in a URI identifying the
 132      * acceptor.
 133      */
 134 #if 0
 135     if (gssCred != GSS_C_NO_CREDENTIAL &&
 136         gssEapDisplayName(&minor, gssCred->name, &nameBuf, NULL) == GSS_S_COMPLETE) {
 137         resolver->setApplicationID((const char *)nameBuf.value);
 138         gss_release_buffer(&minor, &nameBuf);
 139     }
 140 #endif
 141
 142     major = gssEapExportSecContext(&minor, gssCtx, &exportedCtx);
 143     if (major == GSS_S_COMPLETE) {
 144         resolver->addToken(&exportedCtx);
 145         gss_release_buffer(&minor, &exportedCtx);
 146     }
 147
 148     if (saml != NULL && saml->getAssertion() != NULL) {
 149         resolver->addToken(saml->getAssertion());
 150         m_authenticated = saml->authenticated();
 151     }
 152
 153     try {
 154         resolver->resolve();
 155         m_attributes = resolver->getResolvedAttributes();
 156         resolver->getResolvedAttributes().clear();
 157     } catch (exception &e) {
 158     }
 159
 160     m_initialized = true;
 161
 162     return true;
 163 }
 164
 165 ssize_t
 166 gss_eap_shib_attr_provider::getAttributeIndex(const gss_buffer_t attr) const
 167 {
 168     int i = 0;
 169
 170     assert(m_initialized);
 171
 172     for (vector<Attribute *>::const_iterator a = m_attributes.begin();
 173          a != m_attributes.end();
 174          ++a)
 175     {
 176         for (vector<string>::const_iterator s = (*a)->getAliases().begin();
 177              s != (*a)->getAliases().end();
 178              ++s) {
 179             if (attr->length == (*s).length() &&
 180                 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
 181                 return i;
 182             }
 183         }
 184     }
 185
 186     return -1;
 187 }
 188
 189 bool
 190 gss_eap_shib_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
 191                                          const gss_buffer_t attr,
 192                                          const gss_buffer_t value)
 193 {
 194     string attrStr((char *)attr->value, attr->length);
 195     vector <string> ids(1, attrStr);
 196     SimpleAttribute *a = new SimpleAttribute(ids);
 197
 198     assert(m_initialized);
 199
 200     if (value->length != 0) {
 201         string valueStr((char *)value->value, value->length);
 202
 203         a->getValues().push_back(valueStr);
 204     }
 205
 206     m_attributes.push_back(a);
 207     m_authenticated = false;
 208
 209     return true;
 210 }
 211
 212 bool
 213 gss_eap_shib_attr_provider::deleteAttribute(const gss_buffer_t attr)
 214 {
 215     int i;
 216
 217     assert(m_initialized);
 218
 219     i = getAttributeIndex(attr);
 220     if (i >= 0)
 221         m_attributes.erase(m_attributes.begin() + i);
 222
 223     m_authenticated = false;
 224
 225     return true;
 226 }
 227
 228 bool
 229 gss_eap_shib_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
 230                                               void *data) const
 231 {
 232     assert(m_initialized);
 233
 234     for (vector<Attribute*>::const_iterator a = m_attributes.begin();
 235         a != m_attributes.end();
 236         ++a)
 237     {
 238         gss_buffer_desc attribute;
 239
 240         attribute.value = (void *)((*a)->getId());
 241         attribute.length = strlen((char *)attribute.value);
 242
 243         if (!addAttribute(m_manager, this, &attribute, data))
 244             return false;
 245     }
 246
 247     return true;
 248 }
 249
 250 const Attribute *
 251 gss_eap_shib_attr_provider::getAttribute(const gss_buffer_t attr) const
 252 {
 253     const Attribute *ret = NULL;
 254
 255     assert(m_initialized);
 256
 257     for (vector<Attribute *>::const_iterator a = m_attributes.begin();
 258          a != m_attributes.end();
 259          ++a)
 260     {
 261         for (vector<string>::const_iterator s = (*a)->getAliases().begin();
 262              s != (*a)->getAliases().end();
 263              ++s) {
 264             if (attr->length == (*s).length() &&
 265                 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
 266                 ret = *a;
 267                 break;
 268             }
 269         }
 270         if (ret != NULL)
 271             break;
 272     }
 273
 274     return ret;
 275 }
 276
 277 bool
 278 gss_eap_shib_attr_provider::getAttribute(const gss_buffer_t attr,
 279                                          int *authenticated,
 280                                          int *complete,
 281                                          gss_buffer_t value,
 282                                          gss_buffer_t display_value,
 283                                          int *more) const
 284 {
 285     const Attribute *shibAttr = NULL;
 286     gss_buffer_desc buf;
 287     int nvalues, i = *more;
 288
 289     assert(m_initialized);
 290
 291     *more = 0;
 292
 293     shibAttr = getAttribute(attr);
 294     if (shibAttr == NULL)
 295         return false;
 296
 297     nvalues = shibAttr->valueCount();
 298
 299     if (i == -1)
 300         i = 0;
 301     else if (i >= nvalues)
 302         return false;
 303
 304     buf.value = (void *)shibAttr->getSerializedValues()[*more].c_str();
 305     buf.length = strlen((char *)buf.value);
 306
 307     if (buf.length != 0) {
 308         if (value != NULL)
 309             duplicateBuffer(buf, value);
 310
 311         if (display_value != NULL)
 312             duplicateBuffer(buf, display_value);
 313     }
 314
 315     if (authenticated != NULL)
 316         *authenticated = m_authenticated;
 317     if (complete != NULL)
 318         *complete = false;
 319
 320     if (nvalues > ++i)
 321         *more = i;
 322
 323     return true;
 324 }
 325
 326 gss_any_t
 327 gss_eap_shib_attr_provider::mapToAny(int authenticated,
 328                                      gss_buffer_t type_id GSSEAP_UNUSED) const
 329 {
 330     gss_any_t output;
 331
 332     assert(m_initialized);
 333
 334     if (authenticated && !m_authenticated)
 335         return (gss_any_t)NULL;
 336
 337     vector <Attribute *>v = duplicateAttributes(m_attributes);
 338
 339     output = (gss_any_t)new vector <Attribute *>(v);
 340
 341     return output;
 342 }
 343
 344 void
 345 gss_eap_shib_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
 346                                                   gss_any_t input) const
 347 {
 348     assert(m_initialized);
 349
 350     vector <Attribute *> *v = ((vector <Attribute *> *)input);
 351     delete v;
 352 }
 353
 354 const char *
 355 gss_eap_shib_attr_provider::prefix(void) const
 356 {
 357     return NULL;
 358 }
 359
 360 const char *
 361 gss_eap_shib_attr_provider::name(void) const
 362 {
 363     return "local";
 364 }
 365
 366 JSONObject
 367 gss_eap_shib_attr_provider::jsonRepresentation(void) const
 368 {
 369     JSONObject obj;
 370
 371     if (m_initialized == false)
 372         return obj; /* don't export incomplete context */
 373
 374     JSONObject attrs = JSONObject::array();
 375
 376     for (vector<Attribute*>::const_iterator a = m_attributes.begin();
 377          a != m_attributes.end(); ++a) {
 378         DDF attr = (*a)->marshall();
 379         JSONObject jobj(attr);
 380         attrs.append(jobj);
 381     }
 382
 383     obj.set("attributes", attrs);
 384
 385     obj.set("authenticated", m_authenticated);
 386
 387     return obj;
 388 }
 389
 390 bool
 391 gss_eap_shib_attr_provider::initWithJsonObject(const gss_eap_attr_ctx *ctx,
 392                                                JSONObject &obj)
 393 {
 394     if (!gss_eap_attr_provider::initWithJsonObject(ctx, obj))
 395         return false;
 396
 397     assert(m_authenticated == false);
 398     assert(m_attributes.size() == 0);
 399
 400     JSONObject attrs = obj["attributes"];
 401     size_t nelems = attrs.size();
 402
 403     for (size_t i = 0; i < nelems; i++) {
 404         DDF attr = attrs.get(i).ddf();
 405         Attribute *attribute = Attribute::unmarshall(attr);
 406         m_attributes.push_back(attribute);
 407     }
 408
 409     m_authenticated = obj["authenticated"].integer();
 410     m_initialized = true;
 411
 412     return true;
 413 }
 414
 415 bool
 416 gss_eap_shib_attr_provider::init(void)
 417 {
 418     if (!ShibbolethResolver::init())
 419         return false;
 420
 421     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_LOCAL, createAttrContext);
 422
 423     return true;
 424 }
 425
 426 void
 427 gss_eap_shib_attr_provider::finalize(void)
 428 {
 429     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_LOCAL);
 430     ShibbolethResolver::term();
 431 }
 432
 433 OM_uint32
 434 gss_eap_shib_attr_provider::mapException(OM_uint32 *minor,
 435                                          std::exception &e) const
 436 {
 437     if (typeid(e) == typeid(AttributeException))
 438         *minor = GSSEAP_SHIB_ATTR_FAILURE;
 439     else if (typeid(e) == typeid(AttributeExtractionException))
 440         *minor = GSSEAP_SHIB_ATTR_EXTRACT_FAILURE;
 441     else if (typeid(e) == typeid(AttributeFilteringException))
 442         *minor = GSSEAP_SHIB_ATTR_FILTER_FAILURE;
 443     else if (typeid(e) == typeid(AttributeResolutionException))
 444         *minor = GSSEAP_SHIB_ATTR_RESOLVE_FAILURE;
 445     else if (typeid(e) == typeid(ConfigurationException))
 446         *minor = GSSEAP_SHIB_CONFIG_FAILURE;
 447     else if (typeid(e) == typeid(ListenerException))
 448         *minor = GSSEAP_SHIB_LISTENER_FAILURE;
 449     else
 450         return GSS_S_CONTINUE_NEEDED;
 451
 452     return GSS_S_FAILURE;
 453 }
 454
 455 gss_eap_attr_provider *
 456 gss_eap_shib_attr_provider::createAttrContext(void)
 457 {
 458     return new gss_eap_shib_attr_provider;
 459 }
 460
 461 Attribute *
 462 gss_eap_shib_attr_provider::duplicateAttribute(const Attribute *src)
 463 {
 464     DDF obj = src->marshall();
 465     Attribute *attribute = Attribute::unmarshall(obj);
 466     obj.destroy();
 467
 468     return attribute;
 469 }
 470
 471 vector <Attribute *>
 472 gss_eap_shib_attr_provider::duplicateAttributes(const vector <Attribute *>src)
 473 {
 474     vector <Attribute *> dst;
 475
 476     for (vector<Attribute *>::const_iterator a = src.begin();
 477          a != src.end();
 478          ++a)
 479         dst.push_back(duplicateAttribute(*a));
 480
 481     return dst;
 482 }
 483
 484 OM_uint32
 485 gssEapLocalAttrProviderInit(OM_uint32 *minor)
 486 {
 487     if (!gss_eap_shib_attr_provider::init()) {
 488         *minor = GSSEAP_SHIB_INIT_FAILURE;
 489         return GSS_S_FAILURE;
 490     }
 491     return GSS_S_COMPLETE;
 492 }
 493
 494 OM_uint32
 495 gssEapLocalAttrProviderFinalize(OM_uint32 *minor)
 496 {
 497     gss_eap_shib_attr_provider::finalize();
 498
 499     *minor = 0;
 500     return GSS_S_COMPLETE;
 501 }