com.sun.xml.wss.impl.callback.DecryptionKeyCallback Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/*
* $Id: DecryptionKeyCallback.java,v 1.2 2010-10-21 15:37:24 snajper Exp $
*/
package com.sun.xml.wss.impl.callback;
import javax.security.auth.callback.Callback;
import java.security.cert.X509Certificate;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.math.BigInteger;
import javax.crypto.SecretKey;
/**
* CallBack implementation for decryption key.
*
* @author XWS-Security Team
*/
public class DecryptionKeyCallback extends XWSSCallback implements Callback {
public interface Request {
}
private Request request;
public DecryptionKeyCallback(Request request) {
this.request = request;
}
public Request getRequest() {
return request;
}
/**
* CallBackHandler handling this request should set the private key to be
* used for decryption on the request.
*/
public static abstract class PrivateKeyRequest implements Request {
PrivateKey privateKey;
/**
* Set the PrivateKey to be used for Decryption.
* @param privateKey java.security.PrivateKey
*/
public void setPrivateKey(PrivateKey privateKey) {
this.privateKey = privateKey;
}
/**
* Get the PrivateKey.
* @return java.security.PrivateKey object set on this request.
*/
public PrivateKey getPrivateKey() {
return privateKey;
}
}
/**
* Request for a private key when the X.509 Subject Key Identifier
* value for a corresponding X.509 Certificate is given.
*/
public static class X509SubjectKeyIdentifierBasedRequest
extends PrivateKeyRequest {
private byte[] x509SubjectKeyIdentifier;
/**
* Constructor.
* It takes the byte stream of X509SubjectKeyIdentifier.
*/
public X509SubjectKeyIdentifierBasedRequest(
byte[] x509SubjectKeyIdentifier) {
this.x509SubjectKeyIdentifier = x509SubjectKeyIdentifier;
}
/**
* Get the byte stream of X509SubjectKeyIdentifier set on this request.
* @return byte[] X509SubjectKeyIdentifier value (byte stream).
*/
public byte[] getSubjectKeyIdentifier() {
return x509SubjectKeyIdentifier;
}
}
/**
* Request for a private key when the X.509 Thumb print
* value for a corresponding X.509 Certificate is given.
* TODO: extends PrivateKeyRequest for now
*/
public static class ThumbprintBasedRequest
extends PrivateKeyRequest {
private byte[] x509Thumbprint;
/**
* Constructor.
* It takes the byte stream of X509ThumbPrint.
*/
public ThumbprintBasedRequest(
byte[] x509Thumbprint) {
this.x509Thumbprint = x509Thumbprint;
}
/**
* Get the byte stream of X509ThumbPrint set on this request.
* @return byte[] X509ThumbPrint value (byte stream).
*/
public byte[] getThumbprintIdentifier() {
return x509Thumbprint;
}
}
/**
* Request for a private key when the Issuer Name and Serial Number
* values for a corresponding X.509 Certificate are given.
*/
public static class X509IssuerSerialBasedRequest
extends PrivateKeyRequest {
private String issuerName;
private BigInteger serialNumber;
/**
*
*
* @param issuerName Name of the issuer.
* @param serialNumber serial number of the Certificate.
*
*/
public X509IssuerSerialBasedRequest(
String issuerName,
BigInteger serialNumber) {
this.issuerName = issuerName;
this.serialNumber = serialNumber;
}
/**
* Get the issuer name.
*
* @return String representation of Certificate Issuer name.
*/
public String getIssuerName() {
return issuerName;
}
/**
* Get the Certificate Serial Number.
*
* @return java.math.BigInteger representing the Ceritificate's
* serial number.
*
*/
public BigInteger getSerialNumber() {
return serialNumber;
}
}
/**
* Request for a private key when a corresponding X.509 Certificate
* is given.
*/
public static class X509CertificateBasedRequest extends PrivateKeyRequest {
private X509Certificate certificate;
/**
* Constructor.
*
* @param certificate java.security.X509Certificate
* to be used for Decryption.
*/
public X509CertificateBasedRequest(X509Certificate certificate) {
this.certificate = certificate;
}
/**
* Get the X509Certificate stored in this Request.
*
* @return java.security.X509Certificate
*/
public X509Certificate getX509Certificate() {
return certificate;
}
}
/**
* Request for a symmetric key to be used for decryption.
*/
public static abstract class SymmetricKeyRequest implements Request {
SecretKey symmetricKey;
/**
* Constructor.
*
* @param symmetricKey javax.crypto.SecretKey
* to be used for Decryption.
*
*/
public void setSymmetricKey(SecretKey symmetricKey) {
this.symmetricKey = symmetricKey;
}
/**
* Get the SymmetricKey stored in this Request.
*
* @return javax.crypto.SecretKey
*/
public SecretKey getSymmetricKey() {
return symmetricKey;
}
}
/**
* Given an alias get the javax.crypto.SecretKey
*/
public static class AliasSymmetricKeyRequest extends SymmetricKeyRequest {
private String alias;
/**
* Constructor.
*
* @param alias java.lang.String representing the alias of the
* SymmetircKey to be used for Decryption.
*
*/
public AliasSymmetricKeyRequest(String alias) {
this.alias = alias;
}
/**
* Get the alias stored in this Request.
*
*/
public String getAlias() {
return alias;
}
}
/**
* A Callback initialized with this request should be handled if the
* private key to be used for decryption is to be retrieved given the PublicKey
*/
public static class PublicKeyBasedPrivKeyRequest extends PrivateKeyRequest {
private PublicKey pk;
/**
* Constructor.
*
* @param publicKey java.security.PublicKey.
*
*/
public PublicKeyBasedPrivKeyRequest(PublicKey publicKey) {
this.pk = publicKey;
}
/**
* Get the PublicKey stored in this Request.
*
* @return java.security.PublicKey.
*/
public PublicKey getPublicKey() {
return pk;
}
}
}