X-Git-Url: http://www.project-moonshot.org/gitweb/?p=shibboleth%2Fcpp-opensaml.git;a=blobdiff_plain;f=saml%2Fsaml2%2Fcore%2FAssertions.h;h=765b7a9cdf15a8ed9ed9e45e9ee1a0c6168f3fa1;hp=c6b0350fc137604e9e5f13fa5a981c65d7152bf4;hb=fc51c80cb50454ac8f662f076445e9aa36875ddf;hpb=0beb48ce00d0b6a3f177f7d9b48af1870ee92190 diff --git a/saml/saml2/core/Assertions.h b/saml/saml2/core/Assertions.h index c6b0350..765b7a9 100644 --- a/saml/saml2/core/Assertions.h +++ b/saml/saml2/core/Assertions.h @@ -28,7 +28,8 @@ #include #include -#include +#include +#include #include #include @@ -37,6 +38,11 @@ namespace opensaml { + namespace saml2md { + class SAML_API MetadataProvider; + class SAML_API MetadataCredentialCriteria; + }; + /** * @namespace opensaml::saml2 * SAML 2.0 assertion namespace @@ -46,6 +52,16 @@ namespace opensaml { // Forward references class SAML_API Assertion; class SAML_API EncryptedAssertion; + + /** + * Marker interface for SAML types that can be encrypted. + */ + class SAML_API EncryptableObject : public virtual xmltooling::XMLObject + { + protected: + EncryptableObject() {} + virtual ~EncryptableObject() {} + }; DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDRef,AssertionID,SAML 2.0 AssertionIDRef element); DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionURIRef,AssertionURI,SAML 2.0 AssertionURIRef element); @@ -61,23 +77,60 @@ namespace opensaml { static const XMLCh TYPE_NAME[]; /** - * Decrypts the element using a standard approach based on a wrapped decryption key - * inside the message. The key decryption key should be supplied using the provided - * resolver. The recipient name may be used when multiple encrypted keys are found. - * The object returned will be unmarshalled around the decrypted DOM element, but the - * DOM itself will be released. + * Encrypts an object to a single recipient using this object as a container. + * + * @param xmlObject object to encrypt + * @param metadataProvider a locked MetadataProvider to supply encryption keys + * @param criteria metadata-based CredentialCriteria to use + * @param compact true iff compact KeyInfo should be used + * @param algorithm optionally specifies data encryption algorithm if none can be determined from metadata + * @return the encrypted object + */ + virtual void encrypt( + const EncryptableObject& xmlObject, + const saml2md::MetadataProvider& metadataProvider, + saml2md::MetadataCredentialCriteria& criteria, + bool compact=false, + const XMLCh* algorithm=NULL + ); + + /** + * Encrypts an object to multiple recipients using this object as a container. + * + * @param xmlObject object to encrypt + * @param recipients pairs containing a locked MetadataProvider to supply encryption keys, + * and a metadata-based CredentialCriteria to use + * @param compact true iff compact KeyInfo should be used + * @param algorithm optionally specifies data encryption algorithm if none can be determined from metadata + * @return the encrypted object + */ + virtual void encrypt( + const EncryptableObject& xmlObject, + const std::vector< std::pair >& recipients, + bool compact=false, + const XMLCh* algorithm=NULL + ); + + /** + * Decrypts the element using the supplied CredentialResolver. + * + *

The object returned will be unmarshalled around the decrypted DOM element in a + * new Document owned by the object. * - * @param KEKresolver resolver supplying key decryption key + * @param credResolver locked resolver supplying decryption keys * @param recipient identifier naming the recipient (the entity performing the decryption) + * @param criteria optional external criteria to use with resolver * @return the decrypted and unmarshalled object */ - virtual xmltooling::XMLObject* decrypt(xmltooling::KeyResolver* KEKresolver, const XMLCh* recipient) const=0; + virtual xmltooling::XMLObject* decrypt( + const xmltooling::CredentialResolver& credResolver, const XMLCh* recipient, xmltooling::CredentialCriteria* criteria=NULL + ) const; END_XMLOBJECT; BEGIN_XMLOBJECT(SAML_API,EncryptedID,EncryptedElementType,SAML 2.0 EncryptedID element); END_XMLOBJECT; - BEGIN_XMLOBJECT(SAML_API,BaseID,xmltooling::XMLObject,SAML 2.0 BaseID abstract element); + BEGIN_XMLOBJECT(SAML_API,BaseID,EncryptableObject,SAML 2.0 BaseID abstract element); DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER); DECL_STRING_ATTRIB(SPNameQualifier,SPNAMEQUALIFIER); END_XMLOBJECT; @@ -108,7 +161,7 @@ namespace opensaml { static const XMLCh TRANSIENT[]; END_XMLOBJECT; - BEGIN_XMLOBJECT(SAML_API,NameID,NameIDType,SAML 2.0 NameID element); + BEGIN_XMLOBJECT2(SAML_API,NameID,NameIDType,EncryptableObject,SAML 2.0 NameID element); END_XMLOBJECT; BEGIN_XMLOBJECT(SAML_API,Issuer,NameIDType,SAML 2.0 Issuer element); @@ -146,21 +199,19 @@ namespace opensaml { static const XMLCh TYPE_NAME[]; END_XMLOBJECT; - BEGIN_XMLOBJECT(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,SAML 2.0 SubjectConfirmationData element); + BEGIN_XMLOBJECT(SAML_API,SubjectConfirmationDataType,xmltooling::XMLObject,SAML 2.0 SubjectConfirmationDataType base type); DECL_DATETIME_ATTRIB(NotBefore,NOTBEFORE); DECL_DATETIME_ATTRIB(NotOnOrAfter,NOTONORAFTER); DECL_STRING_ATTRIB(Recipient,RECIPIENT); DECL_STRING_ATTRIB(InResponseTo,INRESPONSETO); DECL_STRING_ATTRIB(Address,ADDRESS); + END_XMLOBJECT; + + BEGIN_XMLOBJECT2(SAML_API,SubjectConfirmationData,SubjectConfirmationDataType,xmltooling::ElementProxy,SAML 2.0 SubjectConfirmationData element); DECL_SIMPLE_CONTENT(Data); END_XMLOBJECT; - BEGIN_XMLOBJECT(SAML_API,KeyInfoConfirmationDataType,xmltooling::AttributeExtensibleXMLObject,SAML 2.0 KeyInfoConfirmationDataType type); - DECL_DATETIME_ATTRIB(NotBefore,NOTBEFORE); - DECL_DATETIME_ATTRIB(NotOnOrAfter,NOTONORAFTER); - DECL_STRING_ATTRIB(Recipient,RECIPIENT); - DECL_STRING_ATTRIB(InResponseTo,INRESPONSETO); - DECL_STRING_ATTRIB(Address,ADDRESS); + BEGIN_XMLOBJECT2(SAML_API,KeyInfoConfirmationDataType,SubjectConfirmationDataType,xmltooling::AttributeExtensibleXMLObject,SAML 2.0 KeyInfoConfirmationDataType type); DECL_TYPED_FOREIGN_CHILDREN(KeyInfo,xmlsignature); /** KeyInfoConfirmationDataType local name */ static const XMLCh TYPE_NAME[]; @@ -172,7 +223,6 @@ namespace opensaml { DECL_TYPED_CHILD(NameID); DECL_TYPED_CHILD(EncryptedID); DECL_XMLOBJECT_CHILD(SubjectConfirmationData); - DECL_TYPED_CHILD(KeyInfoConfirmationDataType); /** SubjectConfirmationType local name */ static const XMLCh TYPE_NAME[]; /** Bearer confirmation method */ @@ -264,9 +314,10 @@ namespace opensaml { END_XMLOBJECT; BEGIN_XMLOBJECT(SAML_API,AttributeValue,xmltooling::ElementProxy,SAML 2.0 AttributeValue element); + DECL_BOOLEAN_ATTRIB(Nil,NIL,false); END_XMLOBJECT; - BEGIN_XMLOBJECT(SAML_API,Attribute,xmltooling::AttributeExtensibleXMLObject,SAML 2.0 Attribute element); + BEGIN_XMLOBJECT2(SAML_API,Attribute,xmltooling::AttributeExtensibleXMLObject,EncryptableObject,SAML 2.0 Attribute element); DECL_STRING_ATTRIB(Name,NAME); DECL_STRING_ATTRIB(NameFormat,NAMEFORMAT); DECL_STRING_ATTRIB(FriendlyName,FRIENDLYNAME); @@ -320,7 +371,7 @@ namespace opensaml { virtual Issuer* getIssuer() const=0; }; - BEGIN_XMLOBJECT2(SAML_API,Assertion,saml2::RootObject,opensaml::Assertion,SAML 2.0 Assertion element); + BEGIN_XMLOBJECT3(SAML_API,Assertion,saml2::RootObject,opensaml::Assertion,EncryptableObject,SAML 2.0 Assertion element); DECL_INHERITED_STRING_ATTRIB(Version,VER); DECL_INHERITED_STRING_ATTRIB(ID,ID); DECL_INHERITED_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT); @@ -407,7 +458,7 @@ namespace opensaml { * This is customized to return a SubjectConfirmationData element with an * xsi:type of KeyInfoConfirmationDataType. */ - class SAML_API KeyInfoConfirmationDataTypeBuilder : public xmltooling::XMLObjectBuilder { + class SAML_API KeyInfoConfirmationDataTypeBuilder : public xmltooling::ConcreteXMLObjectBuilder { public: virtual ~KeyInfoConfirmationDataTypeBuilder() {} /** Default builder. */ @@ -446,7 +497,7 @@ namespace opensaml { throw xmltooling::XMLObjectException("Unable to obtain typed builder for KeyInfoConfirmationDataType."); } }; - + /** * Registers builders and validators for SAML 2.0 Assertion classes into the runtime. */