Bouncy Castle Provider 1.77 · org.bouncycastle.jcajce.provider.asymmetric.ec.GMSignatureSpi

Modifier and Type	Class and Description
public static class	GMSignatureSpi.sha256WithSM2
public static class	GMSignatureSpi.sm3WithSM2

Modifier and Type	Field and Description
private AlgorithmParameters	engineParams
private final JcaJceHelper	helper
private SM2ParameterSpec	paramSpec
private final SM2Signer	signer

Access	Constructor and Description
pack-priv	GMSignatureSpi(SM2Signer signer)

Method Summary

Modifier and Type	Method and Description
protected Object	engineGetParameter(String the string name of the parameter. param) Implements abstract java.security.SignatureSpi.engineGetParameter. Gets the value of the specified algorithm parameter.
protected AlgorithmParameters	engineGetParameters() Overrides java.security.SignatureSpi.engineGetParameters. Returns the parameters used with this `Signature` object.
protected void	engineInitSign(PrivateKey the private key of the identity whose signature will be generated. privateKey) Implements abstract java.security.SignatureSpi.engineInitSign. Initializes this `Signature` object with the specified private key for signing operations.
protected void	engineInitVerify(PublicKey the public key of the identity whose signature is going to be verified. publicKey) Implements abstract java.security.SignatureSpi.engineInitVerify. Initializes this `Signature` object with the specified public key for verification operations.
protected void	engineSetParameter(AlgorithmParameterSpec the parameters params) Overrides java.security.SignatureSpi.engineSetParameter. Initializes this `Signature` object with the specified parameter values.
protected void	engineSetParameter(String the string identifier of the parameter. param, Object the parameter value. value) Implements abstract java.security.SignatureSpi.engineSetParameter. Sets the specified algorithm parameter to the specified value.
protected byte[]	engineSign() Implements abstract java.security.SignatureSpi.engineSign. Returns the signature bytes of all the data updated so far.
protected void	engineUpdate(byte the byte to use for the update. b) Implements abstract java.security.SignatureSpi.engineUpdate. Updates the data to be signed or verified using the specified byte.
protected void	engineUpdate(byte[] the array of bytes bytes, int the offset to start from in the array of bytes off, int the number of bytes to use, starting at offset length) Implements abstract java.security.SignatureSpi.engineUpdate. Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
protected boolean	engineVerify(byte[] the signature bytes to be verified. bytes) Implements abstract java.security.SignatureSpi.engineVerify. Verifies the passed-in signature.

Inherited from java.security.SignatureSpi:: clone engineInitSign engineSign engineUpdate engineVerify

engineParams	back to summary
private AlgorithmParameters engineParams

helper	back to summary
private final JcaJceHelper helper

paramSpec	back to summary
private SM2ParameterSpec paramSpec

signer	back to summary
private final SM2Signer signer

GMSignatureSpi	back to summary
pack-priv GMSignatureSpi(SM2Signer signer)

Method Detail

engineGetParameter back to summary

engineGetParameter	back to summary
protected Object engineGetParameter(String param) Implements abstract java.security.SignatureSpi.engineGetParameter. Doc from java.security.SignatureSpi.engineGetParameter. Gets the value of the specified algorithm parameter. This method supplies a general-purpose mechanism through which it is possible to get the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time. Parameters param:String the string name of the parameter. Returns:Object the object that represents the parameter value, or `null` if there is none.

protected Object engineGetParameter(String param)

Implements abstract java.security.SignatureSpi.engineGetParameter.

Doc from java.security.SignatureSpi.engineGetParameter.

Gets the value of the specified algorithm parameter. This method supplies a general-purpose mechanism through which it is possible to get the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

Parameters

param:String: the string name of the parameter.

Returns:Object

the object that represents the parameter value, or null if there is none.

engineGetParameters back to summary

engineGetParameters	back to summary
protected AlgorithmParameters engineGetParameters() Overrides java.security.SignatureSpi.engineGetParameters. Doc from java.security.SignatureSpi.engineGetParameters. Returns the parameters used with this `Signature` object. The returned parameters may be the same that were used to initialize this `Signature` object, or may contain additional default or random parameter values used by the underlying signature scheme. If the required parameters were not supplied and can be generated by the `Signature` object, the generated parameters are returned; otherwise `null` is returned. However, if the signature scheme does not support returning the parameters as `AlgorithmParameters`, `null` is always returned. Returns:AlgorithmParameters the parameters used with this `Signature` object, or `null`

protected AlgorithmParameters engineGetParameters()

Overrides java.security.SignatureSpi.engineGetParameters.

Doc from java.security.SignatureSpi.engineGetParameters.

Returns the parameters used with this Signature object.

The returned parameters may be the same that were used to initialize this Signature object, or may contain additional default or random parameter values used by the underlying signature scheme. If the required parameters were not supplied and can be generated by the Signature object, the generated parameters are returned; otherwise null is returned.

However, if the signature scheme does not support returning the parameters as AlgorithmParameters, null is always returned.

Returns:AlgorithmParameters: the parameters used with this Signature object, or null

engineInitSign back to summary

engineInitSign	back to summary
protected void engineInitSign(PrivateKey privateKey) throws InvalidKeyException Implements abstract java.security.SignatureSpi.engineInitSign. Doc from java.security.SignatureSpi.engineInitSign. Initializes this `Signature` object with the specified private key for signing operations. Parameters privateKey:PrivateKey the private key of the identity whose signature will be generated. Exceptions InvalidKeyException: if the key is improperly encoded, parameters are missing, and so on.

protected void engineInitSign(PrivateKey privateKey) throws InvalidKeyException

Implements abstract java.security.SignatureSpi.engineInitSign.

Doc from java.security.SignatureSpi.engineInitSign.

Initializes this Signature object with the specified private key for signing operations.

Parameters

privateKey:PrivateKey: the private key of the identity whose signature will be generated.

Exceptions

InvalidKeyException:: if the key is improperly encoded, parameters are missing, and so on.

engineInitVerify back to summary

engineInitVerify	back to summary
protected void engineInitVerify(PublicKey publicKey) throws InvalidKeyException Implements abstract java.security.SignatureSpi.engineInitVerify. Doc from java.security.SignatureSpi.engineInitVerify. Initializes this `Signature` object with the specified public key for verification operations. Parameters publicKey:PublicKey the public key of the identity whose signature is going to be verified. Exceptions InvalidKeyException: if the key is improperly encoded, parameters are missing, and so on.

protected void engineInitVerify(PublicKey publicKey) throws InvalidKeyException

Implements abstract java.security.SignatureSpi.engineInitVerify.

Doc from java.security.SignatureSpi.engineInitVerify.

Initializes this Signature object with the specified public key for verification operations.

Parameters

publicKey:PublicKey: the public key of the identity whose signature is going to be verified.

Exceptions

InvalidKeyException:: if the key is improperly encoded, parameters are missing, and so on.

engineSetParameter back to summary

engineSetParameter	back to summary
protected void engineSetParameter(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException Overrides java.security.SignatureSpi.engineSetParameter. Doc from java.security.SignatureSpi.engineSetParameter. Initializes this `Signature` object with the specified parameter values. Parameters params:AlgorithmParameterSpec the parameters Exceptions InvalidAlgorithmParameterException: if this method is overridden by a provider and the given parameters are inappropriate for this `Signature` object

protected void engineSetParameter(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException

Overrides java.security.SignatureSpi.engineSetParameter.

Doc from java.security.SignatureSpi.engineSetParameter.

Initializes this Signature object with the specified parameter values.

Parameters

params:AlgorithmParameterSpec: the parameters

Exceptions

InvalidAlgorithmParameterException:: if this method is overridden by a provider and the given parameters are inappropriate for this Signature object

engineSetParameter	back to summary
protected void engineSetParameter(String param, Object value) Implements abstract java.security.SignatureSpi.engineSetParameter. Doc from java.security.SignatureSpi.engineSetParameter. Sets the specified algorithm parameter to the specified value. This method supplies a general-purpose mechanism through which it is possible to set the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time. Parameters param:String the string identifier of the parameter. value:Object the parameter value.

engineSetParameter

back to summary

protected void engineSetParameter(String param, Object value)

Implements abstract java.security.SignatureSpi.engineSetParameter.

Doc from java.security.SignatureSpi.engineSetParameter.

Sets the specified algorithm parameter to the specified value. This method supplies a general-purpose mechanism through which it is possible to set the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

Parameters

param:String: the string identifier of the parameter.
value:Object: the parameter value.

engineSign	back to summary
protected byte[] engineSign() throws SignatureException Implements abstract java.security.SignatureSpi.engineSign. Doc from java.security.SignatureSpi.engineSign. Returns the signature bytes of all the data updated so far. The format of the signature depends on the underlying signature scheme. Returns:byte[] the signature bytes of the signing operation's result. Exceptions SignatureException: if the engine is not initialized properly or if this signature algorithm is unable to process the input data provided.

engineSign

back to summary

protected byte[] engineSign() throws SignatureException

Implements abstract java.security.SignatureSpi.engineSign.

Doc from java.security.SignatureSpi.engineSign.

Returns the signature bytes of all the data updated so far. The format of the signature depends on the underlying signature scheme.

Returns:byte[]

the signature bytes of the signing operation's result.

Exceptions

SignatureException:: if the engine is not initialized properly or if this signature algorithm is unable to process the input data provided.

engineUpdate	back to summary
protected void engineUpdate(byte b) throws SignatureException Implements abstract java.security.SignatureSpi.engineUpdate. Doc from java.security.SignatureSpi.engineUpdate. Updates the data to be signed or verified using the specified byte. Parameters b:byte the byte to use for the update. Exceptions SignatureException: if the engine is not initialized properly.

engineUpdate

back to summary

protected void engineUpdate(byte b) throws SignatureException

Implements abstract java.security.SignatureSpi.engineUpdate.

Doc from java.security.SignatureSpi.engineUpdate.

Updates the data to be signed or verified using the specified byte.

Parameters

b:byte: the byte to use for the update.

Exceptions

SignatureException:: if the engine is not initialized properly.

engineUpdate	back to summary
protected void engineUpdate(byte[] bytes, int off, int length) throws SignatureException Implements abstract java.security.SignatureSpi.engineUpdate. Doc from java.security.SignatureSpi.engineUpdate. Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset. Parameters bytes:byte[] the array of bytes off:int the offset to start from in the array of bytes length:int the number of bytes to use, starting at offset Exceptions SignatureException: if the engine is not initialized properly

engineUpdate

back to summary

protected void engineUpdate(byte[] bytes, int off, int length) throws SignatureException

Implements abstract java.security.SignatureSpi.engineUpdate.

Doc from java.security.SignatureSpi.engineUpdate.

Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.

Parameters

bytes:byte[]: the array of bytes
off:int: the offset to start from in the array of bytes
length:int: the number of bytes to use, starting at offset

Exceptions

SignatureException:: if the engine is not initialized properly

engineVerify back to summary

engineVerify	back to summary
protected boolean engineVerify(byte[] bytes) throws SignatureException Implements abstract java.security.SignatureSpi.engineVerify. Doc from java.security.SignatureSpi.engineVerify. Verifies the passed-in signature. Parameters bytes:byte[] the signature bytes to be verified. Returns:boolean `true` if the signature was verified, `false` if not. Exceptions SignatureException: if the engine 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.

protected boolean engineVerify(byte[] bytes) throws SignatureException

Implements abstract java.security.SignatureSpi.engineVerify.

Doc from java.security.SignatureSpi.engineVerify.

Verifies the passed-in signature.

Parameters

bytes:byte[]: the signature bytes to be verified.

Returns:boolean

true if the signature was verified, false if not.

Exceptions

SignatureException:: if the engine 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 Class GMSignatureSpi

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class GMSignatureSpi.sha256WithSM2

Constructor Summary

Method Summary

Constructor Detail

public Class GMSignatureSpi.sm3WithSM2

Constructor Summary

Method Summary

Constructor Detail