com.oneops.proxy.keywhiz

Class KeywhizClient

java.lang.Object

com.oneops.proxy.keywhiz.http.HttpClient

com.oneops.proxy.keywhiz.KeywhizClient

public class KeywhizClient
extends HttpClient

Client for interacting with the Keywhiz Server.

Facilitates the manipulation of Clients, Groups, Secrets and the connections between them.

Field Summary

Fields inherited from class com.oneops.proxy.keywhiz.http.HttpClient

baseUrl, client, JSON, keywhizKeyStore, mapper

Constructor Summary

Constructors

Constructor and Description
KeywhizClient(String baseUrl, KeywhizKeyStore keywhizKeyStore) Create a keywhiz client for the given baseurl.

Method Summary

Modifier and Type	Method and Description
List<Client>	allClients()
List<Group>	allGroups()
List<SanitizedSecret>	allSecrets()
List<SanitizedSecret>	allSecretsBatched(int idx, int num, boolean newestFirst)
ClientDetailResponse	clientDetailsForId(long clientId)
ClientDetailResponse	createClient(String name)
GroupDetailResponse	createGroup(String name, String description, com.google.common.collect.ImmutableMap<String,String> metadata)
SecretDetailResponse	createSecret(String name, String description, byte[] content, com.google.common.collect.ImmutableMap<String,String> metadata, long expiry)
void	deleteClientWithId(long clientId)
void	deleteGroupWithId(long groupId)
void	deleteSecretWithId(long secretId)
void	enrollClientInGroupByIds(long clientId, long groupId)
void	evictClientFromGroupByIds(long clientId, long groupId)
Client	getClientByName(String name)
Group	getGroupByName(String name)
SanitizedSecret	getSanitizedSecretByName(String name)
void	grantSecretToGroupByIds(long secretId, long groupId)
GroupDetailResponse	groupDetailsForId(long groupId)
boolean	isClientAuthEnabled() Check if client auth is enabled (mTLS) instead of session cookie.
boolean	isLoggedIn()
List<SanitizedSecret>	listSecretVersions(String name, int idx, int numVersions)
void	login(String username, char[] password) Login to the Keywhiz server.
void	revokeSecretFromGroupByIds(long secretId, long groupId)
SecretDetailResponse	rollbackSecret(String name, long version)
SecretDetailResponse	secretDetailsForId(long secretId)
SecretDetailResponse	updateSecret(String name, boolean descriptionPresent, String description, boolean contentPresent, byte[] content, boolean metadataPresent, com.google.common.collect.ImmutableMap<String,String> metadata, boolean expiryPresent, long expiry)

Methods inherited from class com.oneops.proxy.keywhiz.http.HttpClient

clearCookies, createHttpsClient, createObjectMapper, httpDelete, httpGet, httpPost, httpPut, makeCall, throwOnCommonError

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywhizClient

public KeywhizClient(String baseUrl,
                     KeywhizKeyStore keywhizKeyStore)
              throws GeneralSecurityException

Create a keywhiz client for the given baseurl.

Parameters:

baseUrl - keywhiz server base url

keywhizKeyStore - keywhiz keystore.

Throws:

GeneralSecurityException - throws if any error creating the https client.

Method Detail

isClientAuthEnabled

public boolean isClientAuthEnabled()

Description copied from class: HttpClient

Check if client auth is enabled (mTLS) instead of session cookie.

Specified by:

isClientAuthEnabled in class HttpClient

Returns:

true if client auth is enabled

login

public void login(String username,
                  char[] password)
           throws IOException

Login to the Keywhiz server.

Future requests made using this client instance will be authenticated.

Parameters:

username - login username

password - login password

Throws:

IOException - if a network IO error occurs

allGroups

public List<Group> allGroups()
                      throws IOException

Throws:

IOException

createGroup

public GroupDetailResponse createGroup(String name,
                                       String description,
                                       com.google.common.collect.ImmutableMap<String,String> metadata)
                                throws IOException

Throws:

IOException

groupDetailsForId

public GroupDetailResponse groupDetailsForId(long groupId)
                                      throws IOException

Throws:

IOException

deleteGroupWithId

public void deleteGroupWithId(long groupId)
                       throws IOException

Throws:

IOException

allSecrets

public List<SanitizedSecret> allSecrets()
                                 throws IOException

Throws:

IOException

allSecretsBatched

public List<SanitizedSecret> allSecretsBatched(int idx,
                                               int num,
                                               boolean newestFirst)
                                        throws IOException

Throws:

IOException

createSecret

public SecretDetailResponse createSecret(String name,
                                         String description,
                                         byte[] content,
                                         com.google.common.collect.ImmutableMap<String,String> metadata,
                                         long expiry)
                                  throws IOException

Throws:

IOException

updateSecret

public SecretDetailResponse updateSecret(String name,
                                         boolean descriptionPresent,
                                         String description,
                                         boolean contentPresent,
                                         byte[] content,
                                         boolean metadataPresent,
                                         com.google.common.collect.ImmutableMap<String,String> metadata,
                                         boolean expiryPresent,
                                         long expiry)
                                  throws IOException

Throws:

IOException

secretDetailsForId

public SecretDetailResponse secretDetailsForId(long secretId)
                                        throws IOException

Throws:

IOException

listSecretVersions

public List<SanitizedSecret> listSecretVersions(String name,
                                                int idx,
                                                int numVersions)
                                         throws IOException

Throws:

IOException

rollbackSecret

public SecretDetailResponse rollbackSecret(String name,
                                           long version)
                                    throws IOException

Throws:

IOException

deleteSecretWithId

public void deleteSecretWithId(long secretId)
                        throws IOException

Throws:

IOException

allClients

public List<Client> allClients()
                        throws IOException

Throws:

IOException

createClient

public ClientDetailResponse createClient(String name)
                                  throws IOException

Throws:

IOException

clientDetailsForId

public ClientDetailResponse clientDetailsForId(long clientId)
                                        throws IOException

Throws:

IOException

deleteClientWithId

public void deleteClientWithId(long clientId)
                        throws IOException

Throws:

IOException

enrollClientInGroupByIds

public void enrollClientInGroupByIds(long clientId,
                                     long groupId)
                              throws IOException

Throws:

IOException

evictClientFromGroupByIds

public void evictClientFromGroupByIds(long clientId,
                                      long groupId)
                               throws IOException

Throws:

IOException

grantSecretToGroupByIds

public void grantSecretToGroupByIds(long secretId,
                                    long groupId)
                             throws IOException

Throws:

IOException

revokeSecretFromGroupByIds

public void revokeSecretFromGroupByIds(long secretId,
                                       long groupId)
                                throws IOException

Throws:

IOException

getClientByName

public Client getClientByName(String name)
                       throws IOException

Throws:

IOException

getGroupByName

public Group getGroupByName(String name)
                     throws IOException

Throws:

IOException

getSanitizedSecretByName

public SanitizedSecret getSanitizedSecretByName(String name)
                                         throws IOException

Throws:

IOException

isLoggedIn

public boolean isLoggedIn()
                   throws IOException

Throws:

IOException