|
Préférences
Moteurs de recherche
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.6.0
java.security
|
Field Summary | |
---|---|
protected static int |
SIGN
Possible state value, signifying that
this signature object has been initialized for signing. |
protected int |
state
Current state of this signature object. |
protected static int |
UNINITIALIZED
Possible state value, signifying that
this signature object has not yet been initialized. |
protected static int |
VERIFY
Possible state value, signifying that
this signature object has been initialized for verification. |
Fields inherited from class java.security.SignatureSpi |
---|
appRandom |
Constructor Summary | |
---|---|
protected |
Signature(String algorithm)
Creates a Signature object for the specified algorithm. |
Method Summary | |
---|---|
Object |
clone()
Returns a clone if the implementation is cloneable. |
String |
getAlgorithm()
Returns the name of the algorithm for this signature object. |
static Signature |
getInstance(String algorithm)
Returns a Signature object that implements the specified signature algorithm. |
static Signature |
getInstance(String algorithm,
Provider provider)
Returns a Signature object that implements the specified signature algorithm. |
static Signature |
getInstance(String algorithm,
String provider)
Returns a Signature object that implements the specified signature algorithm. |
Object |
getParameter(String param)
Deprecated. |
AlgorithmParameters |
getParameters()
Returns the parameters used with this signature object. |
Provider |
getProvider()
Returns the provider of this signature object. |
void |
initSign(PrivateKey privateKey)
Initialize this object for signing. |
void |
initSign(PrivateKey privateKey,
SecureRandom random)
Initialize this object for signing. |
void |
initVerify(Certificate certificate)
Initializes this object for verification, using the public key from the given certificate. |
void |
initVerify(PublicKey publicKey)
Initializes this object for verification. |
void |
setParameter(AlgorithmParameterSpec params)
Initializes this signature engine with the specified parameter set. |
void |
setParameter(String param,
Object value)
Deprecated. Use setParameter . |
byte[] |
sign()
Returns the signature bytes of all the data updated. |
int |
sign(byte[] outbuf,
int offset,
int len)
Finishes the signature operation and stores the resulting signature bytes in the provided buffer outbuf , starting at
offset . |
String |
toString()
Returns a string representation of this signature object, providing information that includes the state of the object and the name of the algorithm used. |
void |
update(byte b)
Updates the data to be signed or verified by a byte. |
void |
update(byte[] data)
Updates the data to be signed or verified, using the specified array of bytes. |
void |
update(byte[] data,
int off,
int len)
Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset. |
void |
update(ByteBuffer data)
Updates the data to be signed or verified using the specified ByteBuffer. |
boolean |
verify(byte[] signature)
Verifies the passed-in signature. |
boolean |
verify(byte[] signature,
int offset,
int length)
Verifies the passed-in signature in the specified array of bytes, starting at the specified offset. |
Methods inherited from class java.security.SignatureSpi |
---|
engineGetParameter, engineGetParameters, engineInitSign, engineInitSign, engineInitVerify, engineSetParameter, engineSetParameter, engineSign, engineSign, engineUpdate, engineUpdate, engineUpdate, engineVerify, engineVerify |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final int UNINITIALIZED
state
value, signifying that
this signature object has not yet been initialized.
protected static final int SIGN
state
value, signifying that
this signature object has been initialized for signing.
protected static final int VERIFY
state
value, signifying that
this signature object has been initialized for verification.
protected int state
Constructor Detail |
---|
protected Signature(String algorithm)
algorithm
- the standard string name of the algorithm.
See Appendix A in the
Java Cryptography Architecture API Specification & Reference
for information about standard algorithm names.Method Detail |
---|
public static Signature getInstance(String algorithm) throws NoSuchAlgorithmException
This method traverses the list of registered security Providers, starting with the most preferred Provider. A new Signature object encapsulating the SignatureSpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
algorithm
- the standard name of the algorithm requested.
See Appendix A in the
Java Cryptography Architecture API Specification & Reference
for information about standard algorithm names.
NoSuchAlgorithmException
- if no Provider supports a
Signature implementation for the
specified algorithm.Provider
public static Signature getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
A new Signature object encapsulating the SignatureSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
algorithm
- the name of the algorithm requested.
See Appendix A in the
Java Cryptography Architecture API Specification & Reference
for information about standard algorithm names.provider
- the name of the provider.
NoSuchAlgorithmException
- if a SignatureSpi
implementation for the specified algorithm is not
available from the specified provider.
NoSuchProviderException
- if the specified provider is not
registered in the security provider list.
IllegalArgumentException
- if the provider name is null
or empty.Provider
public static Signature getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
A new Signature object encapsulating the SignatureSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
algorithm
- the name of the algorithm requested.
See Appendix A in the
Java Cryptography Architecture API Specification & Reference
for information about standard algorithm names.provider
- the provider.
NoSuchAlgorithmException
- if a SignatureSpi
implementation for the specified algorithm is not available
from the specified Provider object.
IllegalArgumentException
- if the provider is null.Provider
public final Provider getProvider()
public final void initVerify(PublicKey publicKey) throws InvalidKeyException
publicKey
- the public key of the identity whose signature is
going to be verified.
InvalidKeyException
- if the key is invalid.public final void initVerify(Certificate certificate) throws InvalidKeyException
If the certificate is of type X.509 and has a key usage
extension field marked as critical, and the value of the key usage
extension field implies that the public key in
the certificate and its corresponding private key are not
supposed to be used for digital signatures, an
InvalidKeyException
is thrown.
certificate
- the certificate of the identity whose signature is
going to be verified.
InvalidKeyException
- if the public key in the certificate
is not encoded properly or does not include required parameter
information or cannot be used for digital signature purposes.public final void initSign(PrivateKey privateKey) throws InvalidKeyException
privateKey
- the private key of the identity whose signature
is going to be generated.
InvalidKeyException
- if the key is invalid.public final void initSign(PrivateKey privateKey, SecureRandom random) throws InvalidKeyException
privateKey
- the private key of the identity whose signature
is going to be generated.random
- the source of randomness for this signature.
InvalidKeyException
- if the key is invalid.public final byte[] sign() throws SignatureException
A call to this method resets this signature object to the state
it was in when previously initialized for signing via a
call to initSign(PrivateKey)
. That is, the object is
reset and available to generate another signature from the same
signer, if desired, via new calls to update
and
sign
.
SignatureException
- if this signature object is not
initialized properly or if this signature algorithm is unable to
process the input data provided.public final int sign(byte[] outbuf, int offset, int len) throws SignatureException
outbuf
, starting at
offset
.
The format of the signature depends on the underlying
signature scheme.
This signature object is reset to its initial state (the state it
was in after a call to one of the initSign
methods) and
can be reused to generate further signatures with the same private key.
outbuf
- buffer for the signature result.offset
- offset into outbuf
where the signature is
stored.len
- number of bytes within outbuf
allotted for the
signature.
outbuf
.
SignatureException
- if this signature object is not
initialized properly, if this signature algorithm is unable to
process the input data provided, or if len
is less
than the actual signature length.public final boolean verify(byte[] signature) throws SignatureException
A call to this method resets this signature object to the state
it was in when previously initialized for verification via a
call to initVerify(PublicKey)
. That is, the object is
reset and available to verify another signature from the identity
whose public key was specified in the call to initVerify
.
signature
- the signature bytes to be verified.
SignatureException
- if this signature object is not
initialized properly, the passed-in signature is improperly
encoded or of the wrong type, if this signature algorithm is unable to
process the input data provided, etc.public final boolean verify(byte[] signature, int offset, int length) throws SignatureException
A call to this method resets this signature object to the state
it was in when previously initialized for verification via a
call to initVerify(PublicKey)
. That is, the object is
reset and available to verify another signature from the identity
whose public key was specified in the call to initVerify
.
signature
- the signature bytes to be verified.offset
- the offset to start from in the array of bytes.length
- the number of bytes to use, starting at offset.
SignatureException
- if this signature object is not
initialized properly, the passed-in signature is improperly
encoded or of the wrong type, if this signature algorithm is unable to
process the input data provided, etc.
IllegalArgumentException
- if the signature
byte array is null, or the offset
or length
is less than 0, or the sum of the offset
and
length
is greater than the length of the
signature
byte array.public final void update(byte b) throws SignatureException
b
- the byte to use for the update.
SignatureException
- if this signature object is not
initialized properly.public final void update(byte[] data) throws SignatureException
data
- the byte array to use for the update.
SignatureException
- if this signature object is not
initialized properly.public final void update(byte[] data, int off, int len) throws SignatureException
data
- the array of bytes.off
- the offset to start from in the array of bytes.len
- the number of bytes to use, starting at offset.
SignatureException
- if this signature object is not
initialized properly.public final void update(ByteBuffer data) throws SignatureException
data.remaining()
bytes
starting at at data.position()
.
Upon return, the buffer's position will be equal to its limit;
its limit will not have changed.
data
- the ByteBuffer
SignatureException
- if this signature object is not
initialized properly.public final String getAlgorithm()
public String toString()
@Deprecated public final void setParameter(String param, Object value) throws InvalidParameterException
setParameter
.
param
- the string identifier of the parameter.value
- the parameter value.
InvalidParameterException
- if param
is an
invalid parameter for this signature algorithm engine,
the parameter is already set
and cannot be set again, a security exception occurs, and so on.getParameter(java.lang.String)
public final void setParameter(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException
params
- the parameters
InvalidAlgorithmParameterException
- if the given parameters
are inappropriate for this signature enginegetParameters()
public final AlgorithmParameters getParameters()
The returned parameters may be the same that were used to initialize this signature, or may contain a combination of default and randomly generated parameter values used by the underlying signature implementation if this signature requires algorithm parameters but was not initialized with any.
setParameter(AlgorithmParameterSpec)
@Deprecated public final Object getParameter(String param) throws InvalidParameterException
param
- the string name of the parameter.
InvalidParameterException
- if param
is an invalid
parameter for this engine, or another exception occurs while
trying to get this parameter.setParameter(String, Object)
public Object clone() throws CloneNotSupportedException
clone
in class SignatureSpi
CloneNotSupportedException
- if this is called
on an implementation that does not support Cloneable
.Cloneable