TlsCrypto (tls 1.58.0.0 API)

All Known Implementing Classes:

AbstractTlsCrypto, BcTlsCrypto, JcaTlsCrypto
```
public interface TlsCrypto
```
Service and object creation interface for the primitive types and services that are associated with cryptography in the API.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TlsSecret`	`adoptSecret(TlsSecret secret)` Adopt the passed in secret, creating a new copy of it..
`TlsCertificate`	`createCertificate(byte[] encoding)` Create a TlsCertificate from a ASN.1 binary encoding of an X.509 certificate.
`TlsDHDomain`	`createDHDomain(TlsDHConfig dhConfig)` Create an domain object supporting the domain parameters described in dhConfig.
`TlsECDomain`	`createECDomain(TlsECConfig ecConfig)` Create an domain object supporting the domain parameters described in ecConfig.
`TlsHash`	`createHash(short hashAlgorithm)` Create a suitable hash for the hash algorithm identifier passed in.
`TlsHMAC`	`createHMAC(int macAlgorithm)` Create a suitable HMAC for the MAC algorithm identifier passed in.
`TlsNonceGenerator`	`createNonceGenerator(byte[] additionalSeedMaterial)` Create a nonce generator.
`TlsSecret`	`createSecret(byte[] data)` Create a TlsSecret object based provided data.
`TlsSRP6Client`	`createSRP6Client(TlsSRPConfig srpConfig)` Create an SRP-6 client.
`TlsSRP6Server`	`createSRP6Server(TlsSRPConfig srpConfig, java.math.BigInteger srpVerifier)` Create an SRP-6 server.
`TlsSRP6VerifierGenerator`	`createSRP6VerifierGenerator(TlsSRPConfig srpConfig)` Create an SRP-6 verifier generator.
`TlsSecret`	`generateRSAPreMasterSecret(ProtocolVersion clientVersion)` Create a TlsSecret object containing a randomly-generated RSA PreMasterSecret
`java.security.SecureRandom`	`getSecureRandom()` Return the primary (safest) SecureRandom for this crypto.
`boolean`	`hasAllRawSignatureAlgorithms()` Return true if this TlsCrypto can perform raw signatures and verifications for all supported algorithms.
`boolean`	`hasDHAgreement()` Return true if this TlsCrypto can support DH key agreement.
`boolean`	`hasECDHAgreement()` Return true if this TlsCrypto can support ECDH key agreement.
`boolean`	`hasEncryptionAlgorithm(int encryptionAlgorithm)` Return true if this TlsCrypto can support the passed in block/stream encryption algorithm.
`boolean`	`hasHashAlgorithm(short hashAlgorithm)` Return true if this TlsCrypto can support the passed in hash algorithm.
`boolean`	`hasMacAlgorithm(int macAlgorithm)` Return true if this TlsCrypto can support the passed in MAC algorithm.
`boolean`	`hasNamedGroup(int namedGroup)` Return true if this TlsCrypto supports the passed in `named group` value.
`boolean`	`hasRSAEncryption()` Return true if this TlsCrypto can support RSA encryption/decryption.
`boolean`	`hasSignatureAlgorithm(int signatureAlgorithm)` Return true if this TlsCrypto can support the passed in signature algorithm (not necessarily in combination with EVERY hash algorithm).
`boolean`	`hasSignatureAndHashAlgorithm(SignatureAndHashAlgorithm sigAndHashAlgorithm)` Return true if this TlsCrypto can support the passed in signature algorithm.
`boolean`	`hasSRPAuthentication()` Return true if this TlsCrypto can support SRP authentication.

- Method Detail
  - hasAllRawSignatureAlgorithms
```
boolean hasAllRawSignatureAlgorithms()
```
    Return true if this TlsCrypto can perform raw signatures and verifications for all supported algorithms.
    
    Returns:
    
    true if this instance can perform raw signatures and verifications for all supported algorithms, false otherwise.
  - hasDHAgreement
```
boolean hasDHAgreement()
```
    Return true if this TlsCrypto can support DH key agreement.
    
    Returns:
    
    true if this instance can support DH key agreement, false otherwise.
  - hasECDHAgreement
```
boolean hasECDHAgreement()
```
    Return true if this TlsCrypto can support ECDH key agreement.
    
    Returns:
    
    true if this instance can support ECDH key agreement, false otherwise.
  - hasEncryptionAlgorithm
```
boolean hasEncryptionAlgorithm(int encryptionAlgorithm)
```
    Return true if this TlsCrypto can support the passed in block/stream encryption algorithm.
    
    Parameters:
    
    encryptionAlgorithm - the algorithm of interest.
    
    Returns:
    
    true if encryptionAlgorithm is supported, false otherwise.
  - hasHashAlgorithm
```
boolean hasHashAlgorithm(short hashAlgorithm)
```
    Return true if this TlsCrypto can support the passed in hash algorithm.
    
    Parameters:
    
    hashAlgorithm - the algorithm of interest.
    
    Returns:
    
    true if hashAlgorithm is supported, false otherwise.
  - hasMacAlgorithm
```
boolean hasMacAlgorithm(int macAlgorithm)
```
    Return true if this TlsCrypto can support the passed in MAC algorithm.
    
    Parameters:
    
    macAlgorithm - the algorithm of interest.
    
    Returns:
    
    true if macAlgorithm is supported, false otherwise.
  - hasNamedGroup
```
boolean hasNamedGroup(int namedGroup)
```
    Return true if this TlsCrypto supports the passed in named group value.
    
    Returns:
    
    true if this instance supports the passed in named group value.
  - hasRSAEncryption
```
boolean hasRSAEncryption()
```
    Return true if this TlsCrypto can support RSA encryption/decryption.
    
    Returns:
    
    true if this instance can support RSA encryption/decryption, false otherwise.
  - hasSignatureAlgorithm
```
boolean hasSignatureAlgorithm(int signatureAlgorithm)
```
    Return true if this TlsCrypto can support the passed in signature algorithm (not necessarily in combination with EVERY hash algorithm).
    
    Parameters:
    
    signatureAlgorithm - the algorithm of interest.
    
    Returns:
    
    true if signatureAlgorithm is supported, false otherwise.
  - hasSignatureAndHashAlgorithm
```
boolean hasSignatureAndHashAlgorithm(SignatureAndHashAlgorithm sigAndHashAlgorithm)
```
    Return true if this TlsCrypto can support the passed in signature algorithm.
    
    Parameters:
    
    sigAndHashAlgorithm - the algorithm of interest.
    
    Returns:
    
    true if sigAndHashAlgorithm is supported, false otherwise.
  - hasSRPAuthentication
```
boolean hasSRPAuthentication()
```
    Return true if this TlsCrypto can support SRP authentication.
    
    Returns:
    
    true if this instance can support SRP authentication, false otherwise.
  - createSecret
```
TlsSecret createSecret(byte[] data)
```
    Create a TlsSecret object based provided data.
    
    Parameters:
    
    data - the data to base the TlsSecret on.
    
    Returns:
    
    a TlsSecret based on random data.
  - generateRSAPreMasterSecret
```
TlsSecret generateRSAPreMasterSecret(ProtocolVersion clientVersion)
```
    Create a TlsSecret object containing a randomly-generated RSA PreMasterSecret
    
    Parameters:
    
    clientVersion - the client version to place in the first 2 bytes
    
    Returns:
    
    a TlsSecret containing the PreMasterSecret.
  - getSecureRandom
```
java.security.SecureRandom getSecureRandom()
```
    Return the primary (safest) SecureRandom for this crypto.
    
    Returns:
    
    a SecureRandom suitable for key generation.
  - createCertificate
```
TlsCertificate createCertificate(byte[] encoding)
                          throws java.io.IOException
```
    Create a TlsCertificate from a ASN.1 binary encoding of an X.509 certificate.
    
    Parameters:
    
    encoding - DER/BER encoding of the certificate of interest.
    
    Returns:
    
    a TlsCertificate.
    
    Throws:
    
    java.io.IOException - if there is an issue on decoding or constructing the certificate.
  - createDHDomain
```
TlsDHDomain createDHDomain(TlsDHConfig dhConfig)
```
    Create an domain object supporting the domain parameters described in dhConfig.
    
    Parameters:
    
    dhConfig - the config describing the DH parameters to use.
    
    Returns:
    
    a TlsECDomain supporting the parameters in ecConfig.
  - createECDomain
```
TlsECDomain createECDomain(TlsECConfig ecConfig)
```
    Create an domain object supporting the domain parameters described in ecConfig.
    
    Parameters:
    
    ecConfig - the config describing the EC parameters to use.
    
    Returns:
    
    a TlsECDomain supporting the parameters in ecConfig.
  - adoptSecret
```
TlsSecret adoptSecret(TlsSecret secret)
```
    Adopt the passed in secret, creating a new copy of it..
    
    Parameters:
    
    secret - the secret to make a copy of.
    
    Returns:
    
    a TlsSecret based the original secret.
  - createHash
```
TlsHash createHash(short hashAlgorithm)
```
    Create a suitable hash for the hash algorithm identifier passed in.
    See enumeration class HashAlgorithm for appropriate argument values.
    
    Parameters:
    
    hashAlgorithm - the hash algorithm the hash needs to implement.
    
    Returns:
    
    a TlsHash.
  - createHMAC
```
TlsHMAC createHMAC(int macAlgorithm)
```
    Create a suitable HMAC for the MAC algorithm identifier passed in.
    See enumeration class MACAlgorithm for appropriate argument values.
    
    Parameters:
    
    macAlgorithm - the MAC algorithm the HMAC needs to match.
    
    Returns:
    
    a TlsHMAC.
  - createNonceGenerator
```
TlsNonceGenerator createNonceGenerator(byte[] additionalSeedMaterial)
```
    Create a nonce generator. Each call should construct a new generator, and the generator should be returned from this call only after automatically seeding from this TlsCrypto's entropy source, and from the provided additional seed material. The output of each returned generator must be completely independent of the others.
    
    Parameters:
    
    additionalSeedMaterial - context-specific seed material
    
    Returns:
    
    a TlsNonceGenerator
  - createSRP6Client
```
TlsSRP6Client createSRP6Client(TlsSRPConfig srpConfig)
```
    Create an SRP-6 client.
    
    Parameters:
    
    srpConfig - client config.
    
    Returns:
    
    an initialised SRP6 client object,
  - createSRP6Server
```
TlsSRP6Server createSRP6Server(TlsSRPConfig srpConfig,
                               java.math.BigInteger srpVerifier)
```
    Create an SRP-6 server.
    
    Parameters:
    
    srpConfig - server config.
    
    srpVerifier - the SRP6 verifier value.
    
    Returns:
    
    an initialised SRP6 server object.
  - createSRP6VerifierGenerator
```
TlsSRP6VerifierGenerator createSRP6VerifierGenerator(TlsSRPConfig srpConfig)
```
    Create an SRP-6 verifier generator.
    
    Parameters:
    
    srpConfig - generator config.
    
    Returns:
    
    an initialized SRP6 verifier generator,

Interface TlsCrypto

Method Summary

Method Detail

hasAllRawSignatureAlgorithms

hasDHAgreement

hasECDHAgreement

hasEncryptionAlgorithm

hasHashAlgorithm

hasMacAlgorithm

hasNamedGroup

hasRSAEncryption

hasSignatureAlgorithm

hasSignatureAndHashAlgorithm

hasSRPAuthentication

createSecret

generateRSAPreMasterSecret

getSecureRandom

createCertificate

createDHDomain

createECDomain

adoptSecret

createHash

createHMAC

createNonceGenerator

createSRP6Client

createSRP6Server

createSRP6VerifierGenerator