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