TPMS_RSA_PARMS (TSS.Java 0.3.0 API)

java.lang.Object
- tss.TpmStructure
- - tss.tpm.TPMS_RSA_PARMS

All Implemented Interfaces:

TPMU_PUBLIC_PARMS, TpmMarshaller
```
public class TPMS_RSA_PARMS
extends TpmStructure
implements TPMU_PUBLIC_PARMS
```
A TPM compatible with this specification and supporting RSA shall support two primes and an exponent of zero. An exponent of zero indicates that the exponent is the default of 216 + 1. Support for other values is optional. Use of other exponents in duplicated keys is not recommended because the resulting keys would not be interoperable with other TPMs.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`exponent` the public exponent A prime number greater than 2.
`short`	`keyBits` number of bits in the public modulus
`TPMU_ASYM_SCHEME`	`scheme` scheme.scheme shall be: for an unrestricted signing key, either TPM_ALG_RSAPSS TPM_ALG_RSASSA or TPM_ALG_NULL for a restricted signing key, either TPM_ALG_RSAPSS or TPM_ALG_RSASSA for an unrestricted decryption key, TPM_ALG_RSAES, TPM_ALG_OAEP, or TPM_ALG_NULL unless the object also has the sign attribute for a restricted decryption key, TPM_ALG_NULL NOTE When both sign and decrypt are SET, restricted shall be CLEAR and scheme shall be TPM_ALG_NULL.
`TPMT_SYM_DEF_OBJECT`	`symmetric` for a restricted decryption key, shall be set to a supported symmetric algorithm, key size, and mode.

Constructor Summary

Constructors
Constructor and Description
`TPMS_RSA_PARMS()` A TPM compatible with this specification and supporting RSA shall support two primes and an exponent of zero.
`TPMS_RSA_PARMS(TPMT_SYM_DEF_OBJECT _symmetric, TPMU_ASYM_SCHEME _scheme, int _keyBits, int _exponent)` A TPM compatible with this specification and supporting RSA shall support two primes and an exponent of zero.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TPMS_RSA_PARMS`	`fromTpm(byte[] x)`
`static TPMS_RSA_PARMS`	`fromTpm(InByteBuf buf)`
`int`	`GetUnionSelector_scheme()`
`void`	`initFromTpm(InByteBuf buf)` Populate this object from the TPM representation in the input byte buffer object
`String`	`toString()`
`void`	`toStringInternal(TpmStructurePrinter _p, int d)` Serialize this object to the structure printer
`byte[]`	`toTpm()` Convert this object to its TPM representation and return it as a byte array
`void`	`toTpm(OutByteBuf buf)` Convert this object to its TPM representation and store in the output byte buffer object

Methods inherited from class tss.TpmStructure
equals, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - symmetric
```
public TPMT_SYM_DEF_OBJECT symmetric
```
    for a restricted decryption key, shall be set to a supported symmetric algorithm, key size, and mode. if the key is not a restricted decryption key, this field shall be set to TPM_ALG_NULL.
  - scheme
```
public TPMU_ASYM_SCHEME scheme
```
    scheme.scheme shall be: for an unrestricted signing key, either TPM_ALG_RSAPSS TPM_ALG_RSASSA or TPM_ALG_NULL for a restricted signing key, either TPM_ALG_RSAPSS or TPM_ALG_RSASSA for an unrestricted decryption key, TPM_ALG_RSAES, TPM_ALG_OAEP, or TPM_ALG_NULL unless the object also has the sign attribute for a restricted decryption key, TPM_ALG_NULL NOTE When both sign and decrypt are SET, restricted shall be CLEAR and scheme shall be TPM_ALG_NULL.
  - keyBits
```
public short keyBits
```
    number of bits in the public modulus
  - exponent
```
public int exponent
```
    the public exponent A prime number greater than 2.
- Constructor Detail
  - TPMS_RSA_PARMS
```
public TPMS_RSA_PARMS(TPMT_SYM_DEF_OBJECT _symmetric,
                      TPMU_ASYM_SCHEME _scheme,
                      int _keyBits,
                      int _exponent)
```
    A TPM compatible with this specification and supporting RSA shall support two primes and an exponent of zero. An exponent of zero indicates that the exponent is the default of 216 + 1. Support for other values is optional. Use of other exponents in duplicated keys is not recommended because the resulting keys would not be interoperable with other TPMs.
    
    Parameters:
    
    _symmetric - for a restricted decryption key, shall be set to a supported symmetric algorithm, key size, and mode. if the key is not a restricted decryption key, this field shall be set to TPM_ALG_NULL.
    
    _scheme - scheme.scheme shall be: for an unrestricted signing key, either TPM_ALG_RSAPSS TPM_ALG_RSASSA or TPM_ALG_NULL for a restricted signing key, either TPM_ALG_RSAPSS or TPM_ALG_RSASSA for an unrestricted decryption key, TPM_ALG_RSAES, TPM_ALG_OAEP, or TPM_ALG_NULL unless the object also has the sign attribute for a restricted decryption key, TPM_ALG_NULL NOTE When both sign and decrypt are SET, restricted shall be CLEAR and scheme shall be TPM_ALG_NULL. (One of TPMS_KEY_SCHEME_ECDH, TPMS_KEY_SCHEME_ECMQV, TPMS_SIG_SCHEME_RSASSA, TPMS_SIG_SCHEME_RSAPSS, TPMS_SIG_SCHEME_ECDSA, TPMS_SIG_SCHEME_ECDAA, TPMS_SIG_SCHEME_SM2, TPMS_SIG_SCHEME_ECSCHNORR, TPMS_ENC_SCHEME_RSAES, TPMS_ENC_SCHEME_OAEP, TPMS_SCHEME_HASH, TPMS_NULL_ASYM_SCHEME)
    
    _keyBits - number of bits in the public modulus
    
    _exponent - the public exponent A prime number greater than 2.
  - TPMS_RSA_PARMS
```
public TPMS_RSA_PARMS()
```
    A TPM compatible with this specification and supporting RSA shall support two primes and an exponent of zero. An exponent of zero indicates that the exponent is the default of 216 + 1. Support for other values is optional. Use of other exponents in duplicated keys is not recommended because the resulting keys would not be interoperable with other TPMs.
- Method Detail
  - GetUnionSelector_scheme
```
public int GetUnionSelector_scheme()
```
  - toTpm
```
public void toTpm(OutByteBuf buf)
```
    Description copied from interface: TpmMarshaller
    
    Convert this object to its TPM representation and store in the output byte buffer object
    
    Specified by:
    
    toTpm in interface TpmMarshaller
    
    Parameters:
    
    buf - An output byte buffer
  - initFromTpm
```
public void initFromTpm(InByteBuf buf)
```
    Description copied from interface: TpmMarshaller
    
    Populate this object from the TPM representation in the input byte buffer object
    
    Specified by:
    
    initFromTpm in interface TpmMarshaller
    
    Parameters:
    
    buf - An input byte buffer
  - toTpm
```
public byte[] toTpm()
```
    Description copied from interface: TpmMarshaller
    
    Convert this object to its TPM representation and return it as a byte array
    
    Specified by:
    
    toTpm in interface TpmMarshaller
    
    Returns:
    
    Byte buffer with the TPM 2.0 compatible wire representation of the object
  - fromTpm
```
public static TPMS_RSA_PARMS fromTpm(byte[] x)
```
  - fromTpm
```
public static TPMS_RSA_PARMS fromTpm(InByteBuf buf)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringInternal
```
public void toStringInternal(TpmStructurePrinter _p,
                             int d)
```
    Description copied from class: TpmStructure
    
    Serialize this object to the structure printer
    
    Specified by:
    
    toStringInternal in class TpmStructure
    
    Parameters:
    
    _p - The structure accumulator
    
    d - The data to serialize

Class TPMS_RSA_PARMS

Field Summary

Constructor Summary

Method Summary

Methods inherited from class tss.TpmStructure

Methods inherited from class java.lang.Object

Field Detail

symmetric

scheme

keyBits

exponent

Constructor Detail

TPMS_RSA_PARMS

TPMS_RSA_PARMS

Method Detail

GetUnionSelector_scheme

toTpm

initFromTpm

toTpm

fromTpm

fromTpm

toString

toStringInternal