util_saml.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 #include "gssapiP_eap.h"
  34
  35 #include <sstream>
  36
  37 #include <xercesc/util/XMLUniDefs.hpp>
  38 #include <xmltooling/XMLToolingConfig.h>
  39 #include <xmltooling/util/XMLHelper.h>
  40
  41 #include <saml/saml1/core/Assertions.h>
  42 #include <saml/saml2/core/Assertions.h>
  43 #include <saml/saml2/metadata/Metadata.h>
  44
  45 using namespace xmltooling;
  46 using namespace opensaml::saml2md;
  47 using namespace opensaml;
  48 using namespace xercesc;
  49 using namespace std;
  50
  51 /*
  52  * gss_eap_saml_assertion_provider is for retrieving the underlying
  53  * assertion.
  54  */
  55 bool
  56 gss_eap_saml_assertion_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
  57                                                          const gss_eap_attr_provider *ctx)
  58 {
  59     /* Then we may be creating from an existing attribute context */
  60     const gss_eap_saml_assertion_provider *saml;
  61
  62     assert(m_assertion == NULL);
  63
  64     if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx))
  65         return false;
  66
  67     saml = static_cast<const gss_eap_saml_assertion_provider *>(ctx);
  68     setAssertion(saml->getAssertion(), saml->authenticated());
  69
  70     return true;
  71 }
  72
  73 bool
  74 gss_eap_saml_assertion_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
  75                                                     const gss_cred_id_t gssCred,
  76                                                     const gss_ctx_id_t gssCtx)
  77 {
  78     const gss_eap_radius_attr_provider *radius;
  79     gss_buffer_desc value = GSS_C_EMPTY_BUFFER;
  80     int authenticated, complete, more = -1;
  81     OM_uint32 minor;
  82
  83     assert(m_assertion == NULL);
  84
  85     if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
  86         return false;
  87
  88     radius = static_cast<const gss_eap_radius_attr_provider *>
  89         (m_manager->getProvider(ATTR_TYPE_RADIUS));
  90     if (radius != NULL &&
  91         radius->getAttribute(512 /* XXX */, &authenticated, &complete,
  92                              &value, NULL, &more)) {
  93         setAssertion(&value, authenticated);
  94         gss_release_buffer(&minor, &value);
  95     } else {
  96         m_assertion = NULL;
  97     }
  98
  99     return true;
 100 }
 101
 102 gss_eap_saml_assertion_provider::~gss_eap_saml_assertion_provider(void)
 103 {
 104     delete m_assertion;
 105 }
 106
 107 void
 108 gss_eap_saml_assertion_provider::setAssertion(const saml2::Assertion *assertion,
 109                                               bool authenticated)
 110 {
 111
 112     delete m_assertion;
 113
 114     if (assertion != NULL) {
 115         m_assertion = dynamic_cast<saml2::Assertion *>(assertion->clone());
 116         m_authenticated = authenticated;
 117     } else {
 118         m_assertion = NULL;
 119         m_authenticated = false;
 120     }
 121 }
 122
 123 void
 124 gss_eap_saml_assertion_provider::setAssertion(const gss_buffer_t buffer,
 125                                               bool authenticated)
 126 {
 127     delete m_assertion;
 128
 129     m_assertion = parseAssertion(buffer);
 130     m_authenticated = (m_assertion != NULL && authenticated);
 131 }
 132
 133 saml2::Assertion *
 134 gss_eap_saml_assertion_provider::parseAssertion(const gss_buffer_t buffer)
 135 {
 136     string str((char *)buffer->value, buffer->length);
 137     istringstream istream(str);
 138     DOMDocument *doc;
 139     const XMLObjectBuilder *b;
 140
 141     doc = XMLToolingConfig::getConfig().getParser().parse(istream);
 142     b = XMLObjectBuilder::getBuilder(doc->getDocumentElement());
 143
 144     return dynamic_cast<saml2::Assertion *>(b->buildFromDocument(doc));
 145 }
 146
 147 bool
 148 gss_eap_saml_assertion_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
 149                                                    void *data) const
 150 {
 151     /* just add the prefix */
 152     return addAttribute(this, GSS_C_NO_BUFFER, data);
 153 }
 154
 155 void
 156 gss_eap_saml_assertion_provider::setAttribute(int complete,
 157                                               const gss_buffer_t attr,
 158                                               const gss_buffer_t value)
 159 {
 160     if (attr == GSS_C_NO_BUFFER || attr->length == 0) {
 161         setAssertion(value);
 162     }
 163 }
 164
 165 void
 166 gss_eap_saml_assertion_provider::deleteAttribute(const gss_buffer_t value)
 167 {
 168     delete m_assertion;
 169     m_assertion = NULL;
 170     m_authenticated = false;
 171 }
 172
 173 bool
 174 gss_eap_saml_assertion_provider::getAttribute(const gss_buffer_t attr,
 175                                               int *authenticated,
 176                                               int *complete,
 177                                               gss_buffer_t value,
 178                                               gss_buffer_t display_value,
 179                                               int *more) const
 180 {
 181     string str;
 182
 183     if (attr != GSS_C_NO_BUFFER || attr->length != 0)
 184         return false;
 185
 186     if (m_assertion == NULL)
 187         return false;
 188
 189     if (*more != -1)
 190         return false;
 191
 192     *authenticated = m_authenticated;
 193     *complete = false;
 194
 195     XMLHelper::serialize(m_assertion->marshall((DOMDocument *)NULL), str);
 196
 197     duplicateBuffer(str, value);
 198     *more = 0;
 199
 200     return true;
 201 }
 202
 203 gss_any_t
 204 gss_eap_saml_assertion_provider::mapToAny(int authenticated,
 205                                           gss_buffer_t type_id) const
 206 {
 207     return (gss_any_t)m_assertion;
 208 }
 209
 210 void
 211 gss_eap_saml_assertion_provider::releaseAnyNameMapping(gss_buffer_t type_id,
 212                                                        gss_any_t input) const
 213 {
 214     delete ((saml2::Assertion *)input);
 215 }
 216
 217 void
 218 gss_eap_saml_assertion_provider::exportToBuffer(gss_buffer_t buffer) const
 219 {
 220     ostringstream sink;
 221     string str;
 222
 223     buffer->length = 0;
 224     buffer->value = NULL;
 225
 226     if (m_assertion == NULL)
 227         return;
 228
 229     sink << *m_assertion;
 230     str = sink.str();
 231
 232     duplicateBuffer(str, buffer);
 233 }
 234
 235 bool
 236 gss_eap_saml_assertion_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
 237                                                 const gss_buffer_t buffer)
 238 {
 239     if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
 240         return false;
 241
 242     if (buffer->length == 0)
 243         return true;
 244
 245     assert(m_assertion == NULL);
 246
 247     setAssertion(buffer);
 248     /* TODO XXX how to propagate authenticated flag? */
 249
 250     return true;
 251 }
 252
 253 bool
 254 gss_eap_saml_assertion_provider::init(void)
 255 {
 256     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML_ASSERTION,
 257                                        "urn:ietf:params:gss-eap:saml-aaa-assertion",
 258                                        gss_eap_saml_assertion_provider::createAttrContext);
 259     return true;
 260 }
 261
 262 void
 263 gss_eap_saml_assertion_provider::finalize(void)
 264 {
 265     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML_ASSERTION);
 266 }
 267
 268 gss_eap_attr_provider *
 269 gss_eap_saml_assertion_provider::createAttrContext(void)
 270 {
 271     return new gss_eap_saml_assertion_provider;
 272 }
 273
 274 /*
 275  * gss_eap_saml_attr_provider is for retrieving the underlying attributes.
 276  */
 277 bool
 278 gss_eap_saml_attr_provider::getAssertion(int *authenticated,
 279                                          const saml2::Assertion **pAssertion) const
 280 {
 281     const gss_eap_saml_assertion_provider *saml;
 282
 283     *authenticated = false;
 284     *pAssertion = NULL;
 285
 286     saml = static_cast<const gss_eap_saml_assertion_provider *>
 287         (m_manager->getProvider(ATTR_TYPE_SAML_ASSERTION));
 288     if (saml == NULL)
 289         return false;
 290
 291     *authenticated = saml->authenticated();
 292     *pAssertion = saml->getAssertion();
 293
 294     return (*pAssertion != NULL);
 295 }
 296
 297 gss_eap_saml_attr_provider::~gss_eap_saml_attr_provider(void)
 298 {
 299     /* Nothing to do, we're just a wrapper around the assertion provider. */
 300 }
 301
 302 bool
 303 gss_eap_saml_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
 304                                               void *data) const
 305 {
 306     const saml2::Assertion *assertion;
 307     bool ret = true;
 308     int authenticated;
 309
 310     if (!getAssertion(&authenticated, &assertion))
 311         return true;
 312
 313     /*
 314      * Note: the first prefix is added by the attribute provider manager
 315      *
 316      * From draft-hartman-gss-eap-naming-00:
 317      *
 318      *   Each attribute carried in the assertion SHOULD also be a GSS name
 319      *   attribute.  The name of this attribute has three parts, all separated
 320      *   by an ASCII space character.  The first part is
 321      *   urn:ietf:params:gss-eap:saml-attr.  The second part is the URI for
 322      *   the SAML attribute name format.  The final part is the name of the
 323      *   SAML attribute.  If the mechanism performs an additional attribute
 324      *   query, the retrieved attributes SHOULD be GSS-API name attributes
 325      *   using the same name syntax.
 326      */
 327     const vector<saml2::Attribute*>& attrs2 =
 328         const_cast<const saml2::AttributeStatement*>(assertion->getAttributeStatements().front())->getAttributes();
 329     for (vector<saml2::Attribute*>::const_iterator a = attrs2.begin();
 330         a != attrs2.end();
 331         ++a)
 332     {
 333         const XMLCh *attributeName = (*a)->getName();
 334         const XMLCh *attributeNameFormat = (*a)->getNameFormat();
 335         XMLCh *qualifiedName;
 336         XMLCh space[2] = { ' ', 0 };
 337         gss_buffer_desc utf8;
 338
 339         qualifiedName = new XMLCh[XMLString::stringLen(attributeName) + 1 +
 340                                   XMLString::stringLen(attributeNameFormat) + 1];
 341         XMLString::copyString(qualifiedName, attributeName);
 342         XMLString::catString(qualifiedName, space);
 343         XMLString::catString(qualifiedName, attributeNameFormat);
 344
 345         utf8.value = (void *)toUTF8(qualifiedName);
 346         utf8.length = strlen((char *)utf8.value);
 347
 348         ret = addAttribute(this, &utf8, data);
 349
 350         delete qualifiedName;
 351
 352         if (!ret)
 353             break;
 354     }
 355
 356     return ret;
 357 }
 358
 359 void
 360 gss_eap_saml_attr_provider::setAttribute(int complete,
 361                                          const gss_buffer_t attr,
 362                                          const gss_buffer_t value)
 363 {
 364 }
 365
 366 void
 367 gss_eap_saml_attr_provider::deleteAttribute(const gss_buffer_t value)
 368 {
 369 }
 370
 371 static BaseRefVectorOf<XMLCh> *
 372 decomposeAttributeName(const gss_buffer_t attr)
 373 {
 374     XMLCh *qualifiedAttr = new XMLCh[attr->length + 1];
 375     XMLString::transcode((const char *)attr->value, qualifiedAttr, attr->length);
 376
 377     BaseRefVectorOf<XMLCh> *components = XMLString::tokenizeString(qualifiedAttr);
 378
 379     delete qualifiedAttr;
 380
 381     return components;
 382 }
 383
 384 bool
 385 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
 386                                          int *authenticated,
 387                                          int *complete,
 388                                          const saml2::Attribute **pAttribute) const
 389 {
 390     const saml2::Assertion *assertion;
 391
 392     *authenticated = false;
 393     *complete = true;
 394     *pAttribute = NULL;
 395
 396     if (!getAssertion(authenticated, &assertion) ||
 397         assertion->getAttributeStatements().size() == 0)
 398         return false;
 399
 400     /* Check the attribute name consists of name format | whsp | name */
 401     BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
 402     if (components == NULL || components->size() != 2) {
 403         delete components;
 404         return false;
 405     }
 406
 407     /* For each attribute statement, look for an attribute match */
 408     const vector <saml2::AttributeStatement *>&statements =
 409         assertion->getAttributeStatements();
 410     const saml2::Attribute *ret = NULL;
 411
 412     for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
 413         s != statements.end();
 414         ++s) {
 415         const vector<saml2::Attribute*>& attrs =
 416             const_cast<const saml2::AttributeStatement*>(*s)->getAttributes();
 417
 418         for (vector<saml2::Attribute*>::const_iterator a = attrs.begin(); a != attrs.end(); ++a) {
 419             if (XMLString::equals((*a)->getNameFormat(), components->elementAt(0)) &&
 420                 XMLString::equals((*a)->getName(), components->elementAt(1))) {
 421                 ret = *a;
 422                 break;
 423             }
 424         }
 425
 426         if (ret != NULL)
 427             break;
 428     }
 429
 430     delete components;
 431
 432     *pAttribute = ret;
 433
 434     return (ret != NULL);
 435 }
 436
 437 bool
 438 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
 439                                          int *authenticated,
 440                                          int *complete,
 441                                          gss_buffer_t value,
 442                                          gss_buffer_t display_value,
 443                                          int *more) const
 444 {
 445     const saml2::Attribute *a;
 446     const saml2::AttributeValue *av;
 447     int nvalues, i = *more;
 448
 449     *more = 0;
 450
 451     if (!getAttribute(attr, authenticated, complete, &a))
 452         return false;
 453
 454     nvalues = a->getAttributeValues().size();
 455
 456     if (i == -1)
 457         i = 0;
 458     else if (i >= nvalues)
 459         return false;
 460     av = dynamic_cast<const saml2::AttributeValue *>(a->getAttributeValues().at(i)
 461 );
 462     if (av != NULL) {
 463         value->value = toUTF8(av->getTextContent(), true);
 464         value->length = strlen((char *)value->value);
 465
 466         if (display_value != NULL)
 467             duplicateBuffer(*value, display_value);
 468
 469         if (nvalues > ++i)
 470             *more = i;
 471     }
 472
 473     return true;
 474 }
 475
 476 gss_any_t
 477 gss_eap_saml_attr_provider::mapToAny(int authenticated,
 478                                      gss_buffer_t type_id) const
 479 {
 480     return (gss_any_t)NULL;
 481 }
 482
 483 void
 484 gss_eap_saml_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id,
 485                                                   gss_any_t input) const
 486 {
 487 }
 488
 489 void
 490 gss_eap_saml_attr_provider::exportToBuffer(gss_buffer_t buffer) const
 491 {
 492     buffer->length = 0;
 493     buffer->value = NULL;
 494 }
 495
 496 bool
 497 gss_eap_saml_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
 498                                            const gss_buffer_t buffer)
 499 {
 500     return gss_eap_attr_provider::initFromBuffer(ctx, buffer);
 501 }
 502
 503 bool
 504 gss_eap_saml_attr_provider::init(void)
 505 {
 506     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML,
 507                                        "urn:ietf:params:gss-eap:saml-attr",
 508                                        gss_eap_saml_attr_provider::createAttrContext);
 509     return true;
 510 }
 511
 512 void
 513 gss_eap_saml_attr_provider::finalize(void)
 514 {
 515     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML);
 516 }
 517
 518 gss_eap_attr_provider *
 519 gss_eap_saml_attr_provider::createAttrContext(void)
 520 {
 521     return new gss_eap_saml_attr_provider;
 522 }