seanjmullan commented on code in PR #234: URL: https://github.com/apache/santuario-xml-security-java/pull/234#discussion_r1431397397
########## src/main/java/org/apache/xml/security/encryption/params/KeyDerivationParameter.java: ########## @@ -0,0 +1,41 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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 + * + * 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. + */ +package org.apache.xml.security.encryption.params; + +/** + * Abstract key derivation class contains the basic parameters used for the key derivation. + * The class should be extended to provide algorithm specific parameters. + */ +public abstract class KeyDerivationParameter { Review Comment: Suggest naming this `KeyDerivationParameters`. ########## src/main/java/org/apache/xml/security/encryption/params/ConcatKeyDerivationParameter.java: ########## @@ -0,0 +1,102 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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 + * + * 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. + */ +package org.apache.xml.security.encryption.params; + +import org.apache.xml.security.algorithms.MessageDigestAlgorithm; +import org.apache.xml.security.utils.EncryptionConstants; + +/** + * Class ConcatKeyDerivationParameter is used to specify parameters for the ConcatKDF key derivation algorithm. + * @see <A HREF="https://www.w3.org/TR/xmlenc-core1/#sec-ConcatKDF";>XML Encryption Syntax and Processing Version 1.1, 5.8.1 + * The ConcatKDF Key Derivation Algorithm</A> + */ +public class ConcatKeyDerivationParameter extends KeyDerivationParameter { + + private String digestAlgorithm; + private String algorithmID; + private String partyUInfo; + private String partyVInfo; + private String suppPubInfo; + private String suppPrivInfo; + + /** + * Constructor ConcatKeyDerivationParameter with specified digest algorithm + * + * @param keyBitLength the length of the derived key in bits + * @param digestAlgorithm the digest algorithm to use + */ + public ConcatKeyDerivationParameter(int keyBitLength, String digestAlgorithm) { Review Comment: Should this be named `ConcatKDFParams` to match the spec? ########## src/main/java/org/apache/xml/security/encryption/params/KeyAgreementParameterSpec.java: ########## @@ -0,0 +1,126 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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 + * + * 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. + */ +package org.apache.xml.security.encryption.params; + +import java.security.KeyPair; +import java.security.PrivateKey; +import java.security.PublicKey; +import java.security.spec.AlgorithmParameterSpec; + +/** + * This class is used to pass parameters to the KeyAgreement algorithm. + */ +public class KeyAgreementParameterSpec implements AlgorithmParameterSpec { + /** + * This enum defines the actor type of the KeyAgreement algorithm. The actor type defines which public and which + * private key is expected to be present for the KeyAgreement algorithm to define derived key. + * <ul> + * <li>ORIGINATOR: The key agreement is used by originator of the message therefore the originator private key and Review Comment: Should be two sentences: "... of the message. Therefore, the ..." ########## src/main/java/org/apache/xml/security/encryption/params/KeyAgreementParameterSpec.java: ########## @@ -0,0 +1,126 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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 + * + * 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. + */ +package org.apache.xml.security.encryption.params; + +import java.security.KeyPair; +import java.security.PrivateKey; +import java.security.PublicKey; +import java.security.spec.AlgorithmParameterSpec; + +/** + * This class is used to pass parameters to the KeyAgreement algorithm. + */ +public class KeyAgreementParameterSpec implements AlgorithmParameterSpec { Review Comment: Suggest renaming to `KeyAgreementParameters`. ########## src/main/java/org/apache/xml/security/encryption/params/KeyAgreementParameterSpec.java: ########## @@ -0,0 +1,126 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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 + * + * 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. + */ +package org.apache.xml.security.encryption.params; + +import java.security.KeyPair; +import java.security.PrivateKey; +import java.security.PublicKey; +import java.security.spec.AlgorithmParameterSpec; + +/** + * This class is used to pass parameters to the KeyAgreement algorithm. + */ +public class KeyAgreementParameterSpec implements AlgorithmParameterSpec { + /** + * This enum defines the actor type of the KeyAgreement algorithm. The actor type defines which public and which + * private key is expected to be present for the KeyAgreement algorithm to define derived key. + * <ul> + * <li>ORIGINATOR: The key agreement is used by originator of the message therefore the originator private key and + * the recipient public key are expected to be present.</li> + * <li>RECIPIENT: The key agreement is used by recipient of the message therefore the recipient private key and Review Comment: Should be two sentences: "... of the message. Therefore, the ..." -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
