javax.security.auth.message.callback.SecretKeyCallback Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-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.
*/
package javax.security.auth.message.callback;
import java.math.BigInteger;
import java.security.Principal;
import javax.crypto.SecretKey;
import javax.security.auth.callback.Callback;
/**
* Callback for acquiring a shared secret from a key repository.
* This Callback may be used by client or server authentication modules
* to obtain shared secrets (for example, passwords) without relying on a
* user during the Callback processing.
* This Callback is typically empoyed by ClientAuthModules
* invoked from intermediate components that need to acquire
* a password to authenticate to their target service.
*
* @version %I%, %G%
*/
public class SecretKeyCallback implements Callback {
private Request request;
private SecretKey key;
/**
* Marker interface for secret key request types.
*/
public static interface Request { };
/**
* Request type for secret keys that are identified using an alias.
*/
public static class AliasRequest implements Request {
private String alias;
/**
* Construct an AliasRequest with an alias.
*
* The alias is used to directly identify the secret key
* to be returned.
*
*
If the alias is null,
* the handler of the callback relies on its own default.
*
* @param alias Name identifier for the secret key, or null.
*/
public AliasRequest(String alias) {
this.alias = alias;
}
/**
* Get the alias.
*
* @return The alias, or null.
*/
public String getAlias() {
return alias;
}
}
/**
* Constructs this SecretKeyCallback with a secret key Request object.
*
*
The request object identifies the secret key
* to be returned.
*
* If the alias is null, the handler of the callback
* relies on its own default.
*
* @param request Request object identifying the secret key, or null.
*/
public SecretKeyCallback(Request request) {
this.request = request;
}
/**
* Used by the CallbackHandler to get the Request object which identifies
* the secret key to be returned.
*
* @return The Request object which identifies the private key
* to be returned, or null. If null, the handler of the callback
* relies on its own default.
*/
public Request getRequest() {
return request;
}
/**
* Used by the CallbackHandler to set the requested secret key within
* the Callback.
*
* @param key The secret key, or null if no key was found.
*/
public void setKey(SecretKey key) {
this.key = key;
}
/**
* Used to obtain the secret key set within the Callback.
*
* @return The secret key, or null if no key was found.
*/
public SecretKey getKey() {
return key;
}
}