Package cloud.pangeacyber.pangea.vault

Class VaultClient

java.lang.Object

cloud.pangeacyber.pangea.Client

cloud.pangeacyber.pangea.vault.VaultClient

public class VaultClient
extends Client

Field Summary

Fields

Modifier and Type	Field	Description
static String	serviceName

Constructor Summary

Constructors

Constructor	Description
VaultClient(Config config)

Method Summary

Modifier and Type	Method	Description
AsymmetricGenerateResponse	asymmetricGenerate(AsymmetricGenerateRequest request)	Generate an asymmetric key
AsymmetricStoreResponse	asymmetricStore(AsymmetricStoreRequest request)	Store an asymmetric key
DecryptResponse	decrypt(String id, String cipherText)	Decrypt
DecryptResponse	decrypt(String id, String cipherText, Integer version)	Decrypt
DeleteResponse	delete(String id)	Delete
EncryptResponse	encrypt(String id, String plainText)	Encrypt
EncryptResponse	encrypt(String id, String plainText, int version)	Encrypt
GetResponse	get(GetRequest request)	Get
JWKGetResponse	jwkGet(String id)	Get JWK
JWKGetResponse	jwkGet(String id, String version)	Get JWK
JWTSignResponse	jwtSign(String id, String payload)	Sign with JWT
JWTVerifyResponse	jwtVerify(String jws)	Verify a JWT signature
KeyRotateResponse	keyRotate(KeyRotateRequest request)	Rotate a key
ListResponse	list(ListRequest request)	List
SecretRotateResponse	pangeaTokenRotate(PangeaTokenStoreRequest request)	Rotate a Pangea Token
SecretStoreResponse	pangeaTokenStore(PangeaTokenStoreRequest request)	Store a Pangea Token
SecretRotateResponse	secretRotate(SecretRotateRequest request)	Rotate a secret
SecretStoreResponse	secretStore(SecretStoreRequest request)	Store a secret
SignResponse	sign(String id, String message)	Sign
SignResponse	sign(String id, String message, int version)	Sign
StateChangeResponse	stateChange(String id, int version, ItemVersionState state)	State change
SymmetricGenerateResponse	symmetricGenerate(SymmetricGenerateRequest request)	Generate a symmetric key
SymmetricStoreResponse	symmetricStore(SymmetricStoreRequest request)	Store a symmetric key
UpdateResponse	update(ListRequest request)	Update
VerifyResponse	verify(String id, String message, String signature)	Verify
VerifyResponse	verify(String id, String message, String signature, Integer version)	Verify

Methods inherited from class cloud.pangeacyber.pangea.Client

buildClient, buildPostRequest, doPost, fillPostHeaders, setCustomHeaders, setCustomUserAgent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serviceName

public static String serviceName

Constructor Details

VaultClient

public VaultClient(Config config)

Method Details

stateChange

public StateChangeResponse stateChange(String id,
 int version,
 ItemVersionState state)
                                throws PangeaException,
PangeaAPIException

State change

Parameters:

id - - item id to change

version - - item version to change

state - - state to set to item version

Returns:

StateChangeResponse

Throws:

PangeaException

PangeaAPIException

Description:

change an item version state

Example:

// TODO:

delete

public DeleteResponse delete(String id)
                      throws PangeaException,
PangeaAPIException

Delete

Parameters:

id - - item id to delete

Returns:

DeleteResponse

Throws:

PangeaException

PangeaAPIException

Description:

Delete an item

Example:

// TODO:

get

public GetResponse get(GetRequest request)
                throws PangeaException,
PangeaAPIException

Get

Parameters:

request - - request to /get endpoint

Returns:

GetResponse

Throws:

PangeaException

PangeaAPIException

Description:

Get an item of any type

Example:

// TODO:

list

public ListResponse list(ListRequest request)
                  throws PangeaException,
PangeaAPIException

List

Parameters:

request - - request parameters to send to list endpoint

Returns:

ListResponse

Throws:

PangeaException

PangeaAPIException

Description:

Retrieve a list of items

Example:

// TODO:

update

public UpdateResponse update(ListRequest request)
                      throws PangeaException,
PangeaAPIException

Update

Parameters:

request - - request parameters to send to update endpoint

Returns:

UpdateResponse

Throws:

PangeaException

PangeaAPIException

Description:

Update the metadata of an item

Example:

// TODO:

secretStore

public SecretStoreResponse secretStore(SecretStoreRequest request)
                                throws PangeaException,
PangeaAPIException

Store a secret

Parameters:

request - - request parameters to send to /secret/store endpoint

Returns:

SecretStoreResponse

Throws:

PangeaException

PangeaAPIException

Description:

Store a secret in vault service

Example:

// TODO:

pangeaTokenStore

public SecretStoreResponse pangeaTokenStore(PangeaTokenStoreRequest request)
                                     throws PangeaException,
PangeaAPIException

Store a Pangea Token

Parameters:

request - - request parameters to send to /secret/store endpoint

Returns:

SecretStoreResponse

Throws:

PangeaException

PangeaAPIException

Description:

Store a pangea token in vault service

Example:

// TODO:

secretRotate

public SecretRotateResponse secretRotate(SecretRotateRequest request)
                                  throws PangeaException,
PangeaAPIException

Rotate a secret

Parameters:

request - - secret rotate request

Returns:

SecretRotateResponse

Throws:

PangeaException

PangeaAPIException

Description:

Rotate a secret in vault service

Example:

// TODO:

pangeaTokenRotate

public SecretRotateResponse pangeaTokenRotate(PangeaTokenStoreRequest request)
                                       throws PangeaException,
PangeaAPIException

Rotate a Pangea Token

Parameters:

request - - pangea token store request

Returns:

SecretRotateResponse

Throws:

PangeaException

PangeaAPIException

Description:

Rotate a Pangea Token in vault service

Example:

// TODO:

symmetricGenerate

public SymmetricGenerateResponse symmetricGenerate(SymmetricGenerateRequest request)
                                            throws PangeaException,
PangeaAPIException

Generate a symmetric key

Parameters:

request - - request parameters to send to /key/generate endpoint

Returns:

SymmetricGenerateResponse

Throws:

PangeaException

PangeaAPIException

Description:

Generate a symmetric key in vault service

Example:

// TODO:

asymmetricGenerate

public AsymmetricGenerateResponse asymmetricGenerate(AsymmetricGenerateRequest request)
                                              throws PangeaException,
PangeaAPIException

Generate an asymmetric key

Parameters:

request - - request parameters to send to /key/generate endpoint

Returns:

AsymmetricGenerateResponse

Throws:

PangeaException

PangeaAPIException

Description:

Generate an asymmetric key in vault service

Example:

// TODO:

asymmetricStore

public AsymmetricStoreResponse asymmetricStore(AsymmetricStoreRequest request)
                                        throws PangeaException,
PangeaAPIException

Store an asymmetric key

Parameters:

request - - request parameters to send to /key/store endpoint

Returns:

AsymmetricStoreResponse

Throws:

PangeaException

PangeaAPIException

Description:

Store an asymmetric key in vault service

Example:

// TODO:

symmetricStore

public SymmetricStoreResponse symmetricStore(SymmetricStoreRequest request)
                                      throws PangeaException,
PangeaAPIException

Store a symmetric key

Parameters:

request - - request parameters to send to /key/store endpoint

Returns:

SymmetricStoreResponse

Throws:

PangeaException

PangeaAPIException

Description:

Store a symmetric key in vault service

Example:

// TODO:

keyRotate

public KeyRotateResponse keyRotate(KeyRotateRequest request)
                            throws PangeaException,
PangeaAPIException

Rotate a key

Parameters:

request - - request parameters to send to /key/rotate endpoint

Returns:

KeyRotateResponse

Throws:

PangeaException

PangeaAPIException

Description:

Rotate a key

Example:

// TODO:

encrypt

public EncryptResponse encrypt(String id,
 String plainText)
                        throws PangeaException,
PangeaAPIException

Encrypt

Parameters:

id - - key id to encrypt message

plainText - - message to encrypt

Returns:

EncryptResponse

Throws:

PangeaException

PangeaAPIException

Description:

Encrypt a message

Example:

// TODO:

encrypt

public EncryptResponse encrypt(String id,
 String plainText,
 int version)
                        throws PangeaException,
PangeaAPIException

Encrypt

Parameters:

id - - key id to encrypt message

plainText - - message to encrypt

version - - key version to encrypt message

Returns:

EncryptResponse

Throws:

PangeaException

PangeaAPIException

Description:

Encrypt a message

Example:

// TODO:

decrypt

public DecryptResponse decrypt(String id,
 String cipherText)
                        throws PangeaException,
PangeaAPIException

Decrypt

Parameters:

id - - key id to encrypt message

cipherText - - message to decrypt

Returns:

DecryptResponse

Throws:

PangeaException

PangeaAPIException

Description:

Decrypt a message

Example:

// TODO:

decrypt

public DecryptResponse decrypt(String id,
 String cipherText,
 Integer version)
                        throws PangeaException,
PangeaAPIException

Decrypt

Parameters:

id - - key id to encrypt message

cipherText - - message to decrypt

version - - key version to use on decryption

Returns:

DecryptResponse

Throws:

PangeaException

PangeaAPIException

Description:

Decrypt a message

Example:

// TODO:

sign

public SignResponse sign(String id,
 String message)
                  throws PangeaException,
PangeaAPIException

Sign

Parameters:

id - - key id to sign message

message - - message to sign

Returns:

SignResponse

Throws:

PangeaException

PangeaAPIException

Description:

sign a message

Example:

// TODO:

sign

public SignResponse sign(String id,
 String message,
 int version)
                  throws PangeaException,
PangeaAPIException

Sign

Parameters:

id - - key id to sign message

message - - message to sign

version - - key version to sign message

Returns:

SignResponse

Throws:

PangeaException

PangeaAPIException

Description:

sign a message

Example:

// TODO:

jwtSign

public JWTSignResponse jwtSign(String id,
 String payload)
                        throws PangeaException,
PangeaAPIException

Sign with JWT

Parameters:

id - - key id to sign payload

payload - - message to sign

Returns:

JWTSignResponse

Throws:

PangeaException

PangeaAPIException

Description:

sign a payload with a JWT

Example:

// TODO:

verify

public VerifyResponse verify(String id,
 String message,
 String signature)
                      throws PangeaException,
PangeaAPIException

Verify

Parameters:

id - - key id to verify message/signature

message - - message to verify

signature - - signature to verify

Returns:

VerifyResponse

Throws:

PangeaException

PangeaAPIException

Description:

Verify a message/signature pair

Example:

// TODO:

verify

public VerifyResponse verify(String id,
 String message,
 String signature,
 Integer version)
                      throws PangeaException,
PangeaAPIException

Verify

Parameters:

id - - key id to verify message/signature

message - - message to verify

signature - - signature to verify

version - - key version to use on verification

Returns:

VerifyResponse

Throws:

PangeaException

PangeaAPIException

Description:

Verify a message/signature pair

Example:

// TODO:

jwtVerify

public JWTVerifyResponse jwtVerify(String jws)
                            throws PangeaException,
PangeaAPIException

Verify a JWT signature

Parameters:

jws - - signature to verify

Returns:

JWTVerifyResponse

Throws:

PangeaException

PangeaAPIException

Description:

Verify a JWS

Example:

// TODO:

jwkGet

public JWKGetResponse jwkGet(String id)
                      throws PangeaException,
PangeaAPIException

Get JWK

Parameters:

id - - item id to get

Returns:

GetResponse

Throws:

PangeaException

PangeaAPIException

Description:

Get a JWK

Example:

// TODO:

jwkGet

public JWKGetResponse jwkGet(String id,
 String version)
                      throws PangeaException,
PangeaAPIException

Get JWK

Parameters:

id - - item id to get

version - - item version/versions to get

Returns:

GetResponse

Throws:

PangeaException

PangeaAPIException

Description:

Get a JWK

Example:

// TODO: