/*
- * The Shibboleth License, Version 1.
- * Copyright (c) 2002
- * University Corporation for Advanced Internet Development, Inc.
- * All rights reserved
+ * Copyright 2001-2007 Internet2
*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
*
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution, if any, must include
- * the following acknowledgment: "This product includes software developed by
- * the University Corporation for Advanced Internet Development
- * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
- * may appear in the software itself, if and wherever such third-party
- * acknowledgments normally appear.
- *
- * Neither the name of Shibboleth nor the names of its contributors, nor
- * Internet2, nor the University Corporation for Advanced Internet Development,
- * Inc., nor UCAID may be used to endorse or promote products derived from this
- * software without specific prior written permission. For written permission,
- * please contact shibboleth@shibboleth.org
- *
- * Products derived from this software may not be called Shibboleth, Internet2,
- * UCAID, or the University Corporation for Advanced Internet Development, nor
- * may Shibboleth appear in their name, without prior written permission of the
- * University Corporation for Advanced Internet Development.
- *
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
- * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
- * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
- * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
- * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
*/
-
/* shib.h - Shibboleth header file
Scott Cantor
#ifndef __shib_h__
#define __shib_h__
-#include <ctime>
+#include <saml/saml2/metadata/Metadata.h>
+#include <saml/saml2/metadata/MetadataProvider.h>
+#include <xmltooling/security/TrustEngine.h>
+
#include <saml/saml.h>
+#undef SAML10_PROTOCOL_ENUM
#ifdef WIN32
# ifndef SHIB_EXPORTS
namespace shibboleth
{
-#ifdef NO_RTTI
- extern SHIB_EXPORTS const unsigned short RTTI_UnsupportedProtocolException;
- extern SHIB_EXPORTS const unsigned short RTTI_OriginSiteMapperException;
-#endif
-
- #define DECLARE_SHIB_EXCEPTION(name,base) \
- class SHIB_EXPORTS name : public saml::base \
- { \
- public: \
- name(const char* msg) : saml::base(msg) {RTTI(name); m_typename=#name;} \
- name(const std::string& msg) : saml::base(msg) {RTTI(name); m_typename=#name;} \
- name(const saml::Iterator<saml::QName>& codes, const char* msg) : saml::base(codes,msg) {RTTI(name); m_typename=#name;} \
- name(const saml::Iterator<saml::QName>& codes, const std::string& msg) : saml::base(codes, msg) {RTTI(name); m_typename=#name;} \
- name(const saml::QName& code, const char* msg) : saml::base(code,msg) {RTTI(name); m_typename=#name;} \
- name(const saml::QName& code, const std::string& msg) : saml::base(code, msg) {RTTI(name); m_typename=#name;} \
- name(DOMElement* e) : saml::base(e) {RTTI(name); m_typename=#name;} \
- name(std::istream& in) : saml::base(in) {RTTI(name); m_typename=#name;} \
- virtual ~name() throw () {} \
- }
-
- DECLARE_SHIB_EXCEPTION(UnsupportedProtocolException,SAMLException);
- DECLARE_SHIB_EXCEPTION(OriginSiteMapperException,SAMLException);
-
-#ifdef SHIB_INSTANTIATE
-# ifdef NO_RTTI
- const unsigned short RTTI_UnsupportedProtocolException= RTTI_EXTENSION_BASE;
- const unsigned short RTTI_OriginSiteMapperException= RTTI_EXTENSION_BASE+1;
-# endif
- template class SHIB_EXPORTS saml::Iterator<std::pair<saml::xstring,bool> >;
- template class SHIB_EXPORTS saml::ArrayIterator<std::pair<saml::xstring,bool> >;
-#endif
-
- struct SHIB_EXPORTS IOriginSiteMapper
+ struct SHIB_EXPORTS IAttributeFactory : public virtual saml::IPlugIn
{
- virtual saml::Iterator<saml::xstring> getHandleServiceNames(const XMLCh* originSite)=0;
- virtual const saml::X509Certificate* getHandleServiceCert(const XMLCh* handleService)=0;
- virtual saml::Iterator<std::pair<saml::xstring,bool> > getSecurityDomains(const XMLCh* originSite)=0;
- virtual const char* getTrustedRoots()=0;
+ virtual saml::SAMLAttribute* build(DOMElement* e) const=0;
+ virtual ~IAttributeFactory() {}
};
- class SHIB_EXPORTS OriginSiteMapper : public IOriginSiteMapper
+ // Subclass around the OpenSAML browser profile interface,
+ // incoporates additional functionality using Shib-defined APIs.
+ class SHIB_EXPORTS ShibBrowserProfile : virtual public saml::SAMLBrowserProfile
{
public:
- OriginSiteMapper();
- ~OriginSiteMapper();
- virtual saml::Iterator<saml::xstring> getHandleServiceNames(const XMLCh* originSite);
- virtual const saml::X509Certificate* getHandleServiceCert(const XMLCh* handleService);
- virtual saml::Iterator<std::pair<saml::xstring,bool> > getSecurityDomains(const XMLCh* originSite);
- virtual const char* getTrustedRoots();
-
- private:
- OriginSiteMapper(const OriginSiteMapper&);
- void operator=(const OriginSiteMapper&);
- IOriginSiteMapper* m_mapper;
- };
+ struct SHIB_EXPORTS ITokenValidator {
+ virtual void validateToken(
+ saml::SAMLAssertion* token,
+ time_t=0,
+ const opensaml::saml2md::RoleDescriptor* role=NULL,
+ const xmltooling::TrustEngine* trustEngine=NULL
+ ) const=0;
+ virtual ~ITokenValidator() {}
+ };
- class SHIB_EXPORTS ShibPOSTProfile
- {
- public:
- ShibPOSTProfile(const saml::Iterator<const XMLCh*>& policies, const XMLCh* receiver, int ttlSeconds);
- ShibPOSTProfile(const saml::Iterator<const XMLCh*>& policies, const XMLCh* issuer);
- virtual ~ShibPOSTProfile();
-
- virtual saml::SAMLAssertion* getSSOAssertion(const saml::SAMLResponse& r);
- virtual saml::SAMLAuthenticationStatement* getSSOStatement(const saml::SAMLAssertion& a);
- virtual saml::SAMLResponse* accept(const XMLByte* buf);
- virtual saml::SAMLResponse* prepare(const XMLCh* recipient,
- const XMLCh* name,
- const XMLCh* nameQualifier,
- const XMLCh* subjectIP,
- const XMLCh* authMethod,
- time_t authInstant,
- const saml::Iterator<saml::SAMLAuthorityBinding*>& bindings,
- const saml::Key& responseKey, const saml::X509Certificate* responseCert=NULL,
- const saml::Key* assertionKey=NULL, const saml::X509Certificate* assertionCert=NULL);
- virtual bool checkReplayCache(const saml::SAMLAssertion& a);
-
- protected:
- virtual void verifySignature(const saml::SAMLSignedObject& obj, const XMLCh* signerName, const saml::X509Certificate* knownKey);
-
- saml::SAMLSignedObject::sigs_t m_algorithm;
- std::vector<const XMLCh*> m_policies;
- XMLCh* m_issuer;
- XMLCh* m_receiver;
- int m_ttlSeconds;
+ ShibBrowserProfile(
+ const ITokenValidator* validator,
+ opensaml::saml2md::MetadataProvider* metadata=NULL,
+ xmltooling::TrustEngine* trust=NULL
+ );
+ virtual ~ShibBrowserProfile();
+
+ virtual saml::SAMLBrowserProfile::BrowserProfileResponse receive(
+ const char* samlResponse,
+ const XMLCh* recipient,
+ saml::IReplayCache* replayCache,
+ int minorVersion=1
+ ) const;
+ virtual saml::SAMLBrowserProfile::BrowserProfileResponse receive(
+ saml::Iterator<const char*> artifacts,
+ const XMLCh* recipient,
+ saml::SAMLBrowserProfile::ArtifactMapper* artifactMapper,
+ saml::IReplayCache* replayCache,
+ int minorVersion=1
+ ) const;
private:
- ShibPOSTProfile(const ShibPOSTProfile&) {}
- ShibPOSTProfile& operator=(const ShibPOSTProfile&) {return *this;}
- };
+ void postprocess(saml::SAMLBrowserProfile::BrowserProfileResponse& bpr, int minorVersion=1) const;
- class SHIB_EXPORTS ClubShibPOSTProfile : public ShibPOSTProfile
- {
- public:
- ClubShibPOSTProfile(const saml::Iterator<const XMLCh*>& policies, const XMLCh* receiver, int ttlSeconds);
- ClubShibPOSTProfile(const saml::Iterator<const XMLCh*>& policies, const XMLCh* issuer);
- virtual ~ClubShibPOSTProfile();
-
- virtual saml::SAMLResponse* prepare(const XMLCh* recipient,
- const XMLCh* name,
- const XMLCh* nameQualifier,
- const XMLCh* subjectIP,
- const XMLCh* authMethod,
- time_t authInstant,
- const saml::Iterator<saml::SAMLAuthorityBinding*>& bindings,
- const saml::Key& responseKey, const saml::X509Certificate* responseCert=NULL,
- const saml::Key* assertionKey=NULL, const saml::X509Certificate* assertionCert=NULL);
-
- protected:
- virtual void verifySignature(const saml::SAMLSignedObject& obj, const XMLCh* signerName, const saml::X509Certificate* knownKey);
- };
-
- class SHIB_EXPORTS ShibPOSTProfileFactory
- {
- public:
- static ShibPOSTProfile* getInstance(const saml::Iterator<const XMLCh*>& policies, const XMLCh* receiver, int ttlSeconds);
- static ShibPOSTProfile* getInstance(const saml::Iterator<const XMLCh*>& policies, const XMLCh* issuer);
+ saml::SAMLBrowserProfile* m_profile;
+ opensaml::saml2md::MetadataProvider* m_metadata;
+ xmltooling::TrustEngine* m_trust;
+ const ITokenValidator* m_validator;
};
class SHIB_EXPORTS ShibConfig
{
public:
- ShibConfig() : mapperCert(NULL), mapperRefreshInterval(0) {}
- virtual ~ShibConfig();
+ ShibConfig() {}
+ virtual ~ShibConfig() {}
// global per-process setup and shutdown of Shibboleth runtime
- virtual bool init()=0;
- virtual void term()=0;
+ virtual bool init();
+ virtual void term();
+
+ // manages specific attribute name to factory mappings
+ void regAttributeMapping(const XMLCh* name, const IAttributeFactory* factory);
+ void unregAttributeMapping(const XMLCh* name);
+ void clearAttributeMappings();
// enables runtime and clients to access configuration
static ShibConfig& getConfig();
-
- virtual IOriginSiteMapper* getMapper()=0;
- virtual void releaseMapper(IOriginSiteMapper* mapper)=0;
-
- /* start of external configuration */
- std::string mapperURL;
- saml::X509Certificate* mapperCert;
- time_t mapperRefreshInterval;
- /* end of external configuration */
- };
-
- struct SHIB_EXPORTS Constants
- {
- static const XMLCh POLICY_INCOMMON[];
- static const XMLCh SHIB_ATTRIBUTE_NAMESPACE_URI[];
- };
-
- class SHIB_EXPORTS XML
- {
- public:
- // URI constants
- static const XMLCh SHIB_NS[];
- static const XMLCh SHIB_SCHEMA_ID[];
-
- struct SHIB_EXPORTS Literals
- {
- // Shibboleth vocabulary
- static const XMLCh Domain[];
- static const XMLCh HandleService[];
- static const XMLCh InvalidHandle[];
- static const XMLCh Name[];
- static const XMLCh OriginSite[];
- static const XMLCh regexp[];
- static const XMLCh Sites[];
-
- // XML vocabulary
- static const XMLCh xmlns_shib[];
- };
- };
-
-
- class SHIB_EXPORTS SAMLBindingFactory
- {
- public:
- static saml::SAMLBinding* getInstance(const XMLCh* protocol=saml::SAMLBinding::SAML_SOAP_HTTPS);
};
}
projects / shibboleth / cpp-sp.git / blobdiff