com.sun.xml.wss.impl.callback.SignatureKeyCallback Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* $Id: SignatureKeyCallback.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.PrivateKey;
import java.security.PublicKey;
import java.security.cert.X509Certificate;
/**
* CallBack implementation for signature key.
*
* @author XWS-Security Team
*/
public class SignatureKeyCallback extends XWSSCallback implements Callback {
public static interface Request {
}
private Request request;
public SignatureKeyCallback(Request request) {
this.request = request;
}
public Request getRequest() {
return request;
}
/**
* A CallbackHandler handling an instance of this request should make
* sure that a private key and a corresponding X.509 certificate must
* be set on the request.
*/
public static abstract class PrivKeyCertRequest implements Request {
PrivateKey privateKey;
X509Certificate certificate;
/**
* Set the Private Key used for Signature Calculation.
*
* @param privateKey java.security.PrivateKey representing the
* PrivateKey to be used for Signature value calculation.
*
*/
public void setPrivateKey(PrivateKey privateKey) {
this.privateKey = privateKey;
}
/**
* Get the PrivateKey stored in this Request.
*
* @return java.security.PrivateKey - PrivateKey to be used for
* Signature value calculation.
*/
public PrivateKey getPrivateKey() {
return privateKey;
}
/**
* Set the X509Certificate used for Signature verification.
*
* @param certificate java.security.X509Certificate to be
* used for Signature Verification.
*
*/
public void setX509Certificate(X509Certificate certificate) {
this.certificate = certificate;
}
/**
* Get the X509Certificate stored in this Request.
*
* @return java.security.X509Certificate - X509Certificate
* to be used for Signature Verification.
*/
public X509Certificate getX509Certificate() {
return certificate;
}
}
/**
* A Callback initialized with this request should be handled if there's
* some default private key to be used for signing.
*/
public static class DefaultPrivKeyCertRequest
extends PrivKeyCertRequest {
}
/**
* A Callback initialized with this request should be handled if the
* private key to be used for signing is mapped to some alias.
*/
public static class AliasPrivKeyCertRequest extends PrivKeyCertRequest {
private String alias;
/**
* Constructor.
*
* @param alias java.lang.String representing the alias of
* the PrivateKey to be used for Signature calculation.
*/
public AliasPrivKeyCertRequest(String alias) {
this.alias = alias;
}
/**
* Get the alias stored in this Request.
*
* @return java.lang.String representing the alias of the PrivateKey
* to be used for Signature calculation.
*/
public String getAlias() {
return alias;
}
}
/**
* A Callback initialized with this request should be handled if the
* private key to be used for signing is to be retrieved given the PublicKey
*/
public static class PublicKeyBasedPrivKeyCertRequest extends PrivKeyCertRequest {
private PublicKey pk;
/**
* Constructor.
*
* @param publicKey java.security.PublicKey.
*/
public PublicKeyBasedPrivKeyCertRequest(PublicKey publicKey) {
this.pk = publicKey;
}
/**
* Get the PublicKey stored in this Request.
*
* @return java.security.PublicKey.
*/
public PublicKey getPublicKey() {
return pk;
}
}
}