-/*
- * 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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * 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.
+ * 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.
*/
/**
#if !defined(__xmltooling_decrypter_h__) && !defined(XMLTOOLING_NO_XMLSEC)
#define __xmltooling_decrypter_h__
-#include <xmltooling/encryption/Encryption.h>
+#include <xmltooling/exceptions.h>
-#include <xsec/xenc/XENCCipher.hpp>
+class XENCCipher;
+class XSECCryptoKey;
namespace xmltooling {
class XMLTOOL_API CredentialCriteria;
namespace xmlencryption {
+ class XMLTOOL_API EncryptedData;
+ class XMLTOOL_API EncryptedKey;
class XMLTOOL_API EncryptedKeyResolver;
/**
/**
* Constructor.
*
+ * <p>The final boolean parameter is used to enforce a requirement for an authenticated cipher
+ * suite such as AES-GCM or similar. These ciphers include an HMAC or equivalent step that
+ * prevents tampering. Newer applications should set this parameter to true unless the ciphertext
+ * has been independently authenticated, and even in such a case, it is rarely possible to prevent
+ * chosen ciphertext attacks by trusted signers.
+ *
* @param credResolver locked credential resolver to supply decryption keys
* @param criteria optional external criteria to use with resolver
- * @param EKresolver locates an EncryptedKey pertaining to the EncryptedData
+ * @param EKResolver locates an EncryptedKey pertaining to the EncryptedData
+ * @param requireAuthenticatedCipher true iff the bulk data encryption algorithm must be an authenticated cipher
*/
Decrypter(
- const xmltooling::CredentialResolver* credResolver=NULL,
- xmltooling::CredentialCriteria* criteria=NULL,
- const EncryptedKeyResolver* EKResolver=NULL
- ) : m_cipher(NULL), m_credResolver(credResolver), m_criteria(criteria), m_EKResolver(EKResolver) {
- }
+ const xmltooling::CredentialResolver* credResolver=nullptr,
+ xmltooling::CredentialCriteria* criteria=nullptr,
+ const EncryptedKeyResolver* EKResolver=nullptr,
+ bool requireAuthenticatedCipher=false
+ );
- ~Decrypter();
+ virtual ~Decrypter();
/**
* Replace the current EncryptedKeyResolver interface, if any, with a new one.
*
- * @param EKresolver the EncryptedKeyResolver to attach
+ * @param EKResolver the EncryptedKeyResolver to attach
*/
- void setEncryptedKeyResolver(const EncryptedKeyResolver* EKResolver) {
- m_EKResolver=EKResolver;
- }
+ void setEncryptedKeyResolver(const EncryptedKeyResolver* EKResolver);
/**
* Replace the current CredentialResolver interface, if any, with a new one.
*
- * @param resolver the locked CredentialResolver to attach, or NULL to clear
+ * @param resolver the locked CredentialResolver to attach, or nullptr to clear
* @param criteria optional external criteria to use with resolver
*/
- void setKEKResolver(const xmltooling::CredentialResolver* resolver, xmltooling::CredentialCriteria* criteria) {
- m_credResolver=resolver;
- m_criteria=criteria;
- }
+ void setKEKResolver(const xmltooling::CredentialResolver* resolver, xmltooling::CredentialCriteria* criteria);
/**
* Decrypts the supplied information using the supplied key, and returns
* @param key the decryption key to use (it will not be freed internally)
* @return the decrypted DOM fragment
*/
- DOMDocumentFragment* decryptData(const EncryptedData& encryptedData, XSECCryptoKey* key);
+ xercesc::DOMDocumentFragment* decryptData(const EncryptedData& encryptedData, XSECCryptoKey* key);
/**
* Decrypts the supplied information and returns the resulting as a DOM
* @param recipient identifier of decrypting entity for use in identifying multi-cast keys
* @return the decrypted DOM fragment
*/
- DOMDocumentFragment* decryptData(const EncryptedData& encryptedData, const XMLCh* recipient=NULL);
+ xercesc::DOMDocumentFragment* decryptData(const EncryptedData& encryptedData, const XMLCh* recipient=nullptr);
/**
+ * Decrypts the supplied information to an output stream.
+ *
+ * @param out output stream to receive the decrypted data
+ * @param encryptedData the data to decrypt
+ * @param key the decryption key to use (it will not be freed internally)
+ */
+ void decryptData(std::ostream& out, const EncryptedData& encryptedData, XSECCryptoKey* key);
+
+ /**
+ * Decrypts the supplied information to an output stream.
+ *
+ * @param out output stream to receive the decrypted data
+ * @param encryptedData the data to decrypt
+ * @param recipient identifier of decrypting entity for use in identifying multi-cast keys
+ */
+ void decryptData(std::ostream& out, const EncryptedData& encryptedData, const XMLCh* recipient=nullptr);
+
+ /**
* Decrypts the supplied information and returns the resulting key.
* The caller is responsible for deleting the key. The algorithm of the
* key must be supplied by the caller based on knowledge of the associated
const xmltooling::CredentialResolver* m_credResolver;
xmltooling::CredentialCriteria* m_criteria;
const EncryptedKeyResolver* m_EKResolver;
+ bool m_requireAuthenticatedCipher;
};
DECL_XMLTOOLING_EXCEPTION(DecryptionException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmlencryption,xmltooling::XMLToolingException,Exceptions in decryption processing);