PEM (FusionAuth JWT 5.2.3 API)

java.lang.Object
- io.fusionauth.pem.domain.PEM

All Implemented Interfaces:: Buildable<PEM>

public class PEM
extends Object
implements Buildable<PEM>

Author:: Daniel DeGroff

Field Summary

Fields
Modifier and Type	Field and Description
`Certificate`	`certificate`
`static String`	`EC_PRIVATE_KEY_PREFIX`
`static String`	`EC_PRIVATE_KEY_SUFFIX`
`static String`	`PKCS_1_PRIVATE_KEY_PREFIX`
`static String`	`PKCS_1_PRIVATE_KEY_SUFFIX`
`static String`	`PKCS_1_PUBLIC_KEY_PREFIX`
`static String`	`PKCS_1_PUBLIC_KEY_SUFFIX`
`static String`	`PKCS_8_PRIVATE_KEY_PREFIX`
`static String`	`PKCS_8_PRIVATE_KEY_SUFFIX`
`PrivateKey`	`privateKey`
`PublicKey`	`publicKey`
`static String`	`X509_CERTIFICATE_PREFIX`
`static String`	`X509_CERTIFICATE_SUFFIX`
`static String`	`X509_PUBLIC_KEY_PREFIX`
`static String`	`X509_PUBLIC_KEY_SUFFIX`

Constructor Summary

Constructors
Constructor and Description

PEM(Certificate certificate)

PEM(PrivateKey privateKey)

PEM(PrivateKey privateKey, PublicKey publicKey)

PEM(PublicKey publicKey)

Constructors
Constructor and Description
`PEM(Certificate certificate)`
`PEM(PrivateKey privateKey)`
`PEM(PrivateKey privateKey, PublicKey publicKey)`
`PEM(PublicKey publicKey)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PEM`	`decode(byte[] bytes)` Decode a PEM in string format.
`static PEM`	`decode(Path path)` Decode a PEM in string format.
`static PEM`	`decode(String encodedPEM)` Decode a PEM in string format.
`static String`	`encode(Certificate certificate)` Encode a certificate in PEM format.
`static String`	`encode(Key key)` Encode a key in PEM format.
`static String`	`encode(PrivateKey privateKey, PublicKey publicKey)` Encode a private key in PEM format given both the private and public key.
`boolean`	`equals(Object o)`
`Certificate`	`getCertificate()`
`<T extends PrivateKey> T`	`getPrivateKey()`
`<T extends PublicKey> T`	`getPublicKey()`
`int`	`hashCode()`

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

Methods inherited from interface io.fusionauth.domain.Buildable
with

- Field Detail
  - EC_PRIVATE_KEY_PREFIX
```
public static final String EC_PRIVATE_KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - EC_PRIVATE_KEY_SUFFIX
```
public static final String EC_PRIVATE_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - PKCS_1_PRIVATE_KEY_PREFIX
```
public static final String PKCS_1_PRIVATE_KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - PKCS_1_PRIVATE_KEY_SUFFIX
```
public static final String PKCS_1_PRIVATE_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - PKCS_1_PUBLIC_KEY_PREFIX
```
public static final String PKCS_1_PUBLIC_KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - PKCS_1_PUBLIC_KEY_SUFFIX
```
public static final String PKCS_1_PUBLIC_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - PKCS_8_PRIVATE_KEY_PREFIX
```
public static final String PKCS_8_PRIVATE_KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - PKCS_8_PRIVATE_KEY_SUFFIX
```
public static final String PKCS_8_PRIVATE_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - X509_CERTIFICATE_PREFIX
```
public static final String X509_CERTIFICATE_PREFIX
```
    See Also:
    
    Constant Field Values
  - X509_CERTIFICATE_SUFFIX
```
public static final String X509_CERTIFICATE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - X509_PUBLIC_KEY_PREFIX
```
public static final String X509_PUBLIC_KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - X509_PUBLIC_KEY_SUFFIX
```
public static final String X509_PUBLIC_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - certificate
```
public Certificate certificate
```
  - privateKey
```
public PrivateKey privateKey
```
  - publicKey
```
public PublicKey publicKey
```
- Constructor Detail
  - PEM
```
public PEM(PrivateKey privateKey,
           PublicKey publicKey)
```
  - PEM
```
public PEM(PublicKey publicKey)
```
  - PEM
```
public PEM(Certificate certificate)
```
  - PEM
```
public PEM(PrivateKey privateKey)
```
- Method Detail
  - decode
```
public static PEM decode(Path path)
```
    Decode a PEM in string format.
    
    Parameters:
    
    path - a path to an encoded PEM
    
    Returns:
    
    a PEM object
  - decode
```
public static PEM decode(String encodedPEM)
```
    Decode a PEM in string format.
    
    Parameters:
    
    encodedPEM - an encoded PEM
    
    Returns:
    
    a PEM object
  - decode
```
public static PEM decode(byte[] bytes)
```
    Decode a PEM in string format.
    
    Parameters:
    
    bytes - a byte array of the PEM
    
    Returns:
    
    a PEM object
  - encode
```
public static String encode(Key key)
```
    Encode a key in PEM format.
    
    Parameters:
    
    key - a key
    
    Returns:
    
    an encoded PEM
  - encode
```
public static String encode(PrivateKey privateKey,
                            PublicKey publicKey)
```
    Encode a private key in PEM format given both the private and public key.
    The use of this method is only necessary if you are providing a private key that does not contain the encoded public key.
    
    Parameters:
    
    privateKey - a private key
    
    publicKey - a public key
    
    Returns:
    
    an encoded PEM
  - encode
```
public static String encode(Certificate certificate)
```
    Encode a certificate in PEM format.
    
    Parameters:
    
    certificate - The certificate.
    
    Returns:
    
    An encoded PEM.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getCertificate
```
public Certificate getCertificate()
```
  - getPrivateKey
```
public <T extends PrivateKey> T getPrivateKey()
```
  - getPublicKey
```
public <T extends PublicKey> T getPublicKey()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PEM

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.fusionauth.domain.Buildable

Field Detail

EC_PRIVATE_KEY_PREFIX

EC_PRIVATE_KEY_SUFFIX

PKCS_1_PRIVATE_KEY_PREFIX

PKCS_1_PRIVATE_KEY_SUFFIX

PKCS_1_PUBLIC_KEY_PREFIX

PKCS_1_PUBLIC_KEY_SUFFIX

PKCS_8_PRIVATE_KEY_PREFIX

PKCS_8_PRIVATE_KEY_SUFFIX

X509_CERTIFICATE_PREFIX

X509_CERTIFICATE_SUFFIX

X509_PUBLIC_KEY_PREFIX

X509_PUBLIC_KEY_SUFFIX

certificate

privateKey

publicKey

Constructor Detail

PEM

PEM

PEM

PEM

Method Detail

decode

decode

decode

encode

encode

encode

equals

getCertificate

getPrivateKey

getPublicKey

hashCode