SDK for Java

The Segura SDK for Java makes it easy for developers to access the Segura services in their code and build robust applications and software using the Segura PAM and DSM services. The services include Credentials, Devices, and DevOps Secret Management.

Requirements

To run the SDK, your system will need to meet the minimum requirements, including having java jdk >= 8. It’s also necessary to get an application token for OAuth 2.0 standard authorization with the system administrator.

Information

• Local caching: all information is stored in a local cache to reduce the response time of requests. The data is encrypted before storage to ensure security.
• Credentials: the credential object provides a set of methods for querying and registering credentials.

Create a CredentialClient

To instantiate a credential client, use the CredentialClient class.
You'll have to provide the following parameters:

• PAM URL.
• client_ID.
• client_secret.

import Segura;
// Instantiate a credential client.
CredentialClient client = new CredentialClient(
    "https://cofre.Segura.com", // PAM URL
    "7e02a0e07eef10e73f56585a9a505fb2e", // OAuth 2.0 Application Client ID
    "431eaba0fb56bf360272b54892" // OAuth 2.0 Application Client Secret
);

Create or update a credential

Use the Save method to create or update a credential. If you find a credential with the provided parameters, you’ll change it; if not, you’ll create a new credential.

Method signature

public void Save(String hostname, String ip, String identifier, String username) { ... }

Parameters required

Example: save a credential

client.Save("mycredential02","22.13.50.71", "5", "credential05");

Search for a registered credential

Use the Get method to query a single credential. Method signature:

public Credential Get(String hostname, String ip, String username) { ... }

Parameters available for filtering

Example: search the credential credential05 from the device with hostname mycredential02

Credential credential = client.Get("mycredential02", "", "credential05");

List credentials

Use the Fetch method to query a list of credentials.

Method signature

public ArrayList<Credential> Fetch(String hostname, String ip, String username, String all) { ... }

Parameters available for filter

Example 1: list all credentials

ArrayList<Credential> credentials = client.Fetch();

Example 2: list all credentials from the device with hostname mycredential02

ArrayList<Credential> credentials = client.Fetch("mycredential02", "", "", "");

Deactivate a credential

Use the Disable method to inactivate a credential.

Method signature

private void Disable(String hostname, String ip, String username) { ... }

Parameters available for filtering

Example: deactivate the credential credential05 from the device with hostname mycredential02

client.Disable("mycredential02","","credential05" );

Devices

The device object provides a set of methods for querying and registering devices.

Create a DeviceClient

To instantiate a device client, use the DeviceClient class.
You will have to provide the following parameters:

• Vault URL.
• client_ID
• client_secret.

import Segura;
// Instantiate a device client.
DeviceClient device = new DeviceClient(
    "https://cofre.Segura.com", // URL
    "7e02a0e07eef10e73f56585a9a505fb2e", // OAuth 2.0 Application
    "431eaba0fb56bf360272b54892" // OAuth 2.0 Application Client
);

Create or update a device

Use the Save method to create or update a device. If a device with the provided parameters is found, it will be changed; otherwise, a new device will be created.

Method signature

public void Save(String hostname, String ip, String site, String model, String vendor, String type) { ... }

Parameters required

Example: save a device

client.Save("mydevice02","22.13.50.71","AWS","CentOS 7","CentOS",       "Server");

Search for a registered device

Use the Get method to query a single device.

Method signature

public Device Get(String identifier) { ... }

Required parameter for filter

Example: search the localhost hostname device

Device device = client.Get("localhost");

List devices

Use the Fetch method to query a list of devices. Method signature:

public ArrayList<Device> Fetch(String hostname, String ip, String type, String vendor, String model, { ... }

Parameters available for filtering

Example 1: listing all devices

ArrayList<Device> devices = client.Fetch();

Example 2: list devices of type server

ArrayList<Device> devices = client.Fetch("server");

Deactivate a device

Use the Disable method to inactivate a device.

Method signature

private void Disable(String identifier) { ... }

Required parameters for filter

Example: Inactivate the localhost hostname device

client.Disable("localhost");

Devops secret management

The DSM object provides a set of methods for registering an application and managing its secrets and variables.

Creating a dsm client

To instantiate an application client, use the ApplicationClient class.
You’ll have to provide the following parameters:

• Vault URL.
• client_ID.
• client_secret.

import Segura;
ApplicationClient client = new ApplicationClient(
    "https://cofre.Segura.com", // PAM URL
    "7e02a0e07eef10e73f56585a9a505fb2e", // OAuth 2.0 A
    "431eaba0fb56bf360272b54892" // OAuth 2.0 Applicati
);

Create or update an application

Use the Save method to create or update the application. If the client has an application with the combination of application, system, and environment, it will be changed; otherwise, a new application or authorization will be created. If the application has dynamic provisioning enabled, the target will automatically provision a secret.

Method signature

public void Save(String application, String system, String environment, String unique_key) { ... }

Parameters required

Optional parameter

Example: save an application

client.Save("checkout", "ecommerce", "production","");

Get the client application info and secrets

Use the Get method to return the client application information.

Application application = client.Get();

Method signature

public Application Get() { ... }

Example: get the application information and secrets

Application application = client.Get();

Register application secrets

Use the RegisterSecret method to register the application secrets.

Method signature:

public void RegisterSecret(String secret_type, String access_keys, String key_value, String credential { ... }

Required parameter

Other required parameters (depend on the secret_type)

Example: create an application secret (for key_value type)

client.RegisterSecret("key_value", "access_keys", new ArrayList<HashMap.SimpleEntry<String, String>>() {{
    add(new HashMap.SimpleEntry<>("key1", "val1"));
    add(new HashMap.SimpleEntry<>("key2", "val2"));
    add(new HashMap.SimpleEntry<>("key3", "val3"));
}}, "", "", "");

Register application variables

Use the RegisterVariables method to register the application variables

Method signature

public void RegisterVariables(String env, String helm, String map) { ... }

Parameters required

Example: register the application variables

client.RegisterVariables("PATH=C:\\,SHELL=cmd","helm", "map");

Delete the application authorization

Use the Delete method to delete the client application authorization. If dynamic provisioning is enabled for the application, all secrets will be unprovisioned automatically.

Method signature

public void Delete() { ... }

Example: delete the client application authorization

client.Delete();