-/*
- * Copyright 2001-2010 Internet2
+/**
+ * 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.
*
- * 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
+ * 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.
*/
/**
* <p>The object returned will be unmarshalled around the decrypted DOM element in a
* new Document owned by the object.
*
+ * <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 resolver supplying decryption keys
* @param recipient identifier naming the recipient (the entity performing the decryption)
* @param criteria optional external criteria to use with resolver
+ * @param requireAuthenticatedCipher true iff the bulk data encryption algorithm must be an authenticated cipher
* @return the decrypted and unmarshalled object
*/
virtual xmltooling::XMLObject* decrypt(
- const xmltooling::CredentialResolver& credResolver, const XMLCh* recipient, xmltooling::CredentialCriteria* criteria=nullptr
+ const xmltooling::CredentialResolver& credResolver,
+ const XMLCh* recipient,
+ xmltooling::CredentialCriteria* criteria=nullptr,
+ bool requireAuthenticatedCipher=false
) const;
END_XMLOBJECT;