Google Secret Management Client for Java

Java idiomatic client for Secret Management.

Quickstart

If you are using Maven with BOM, add this to your pom.xml file

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>20.9.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-secretmanager</artifactId>
  </dependency>
</dependencies>

If you are using Maven without BOM, add this to your dependencies:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-secretmanager</artifactId>
  <version>1.6.4</version>
</dependency>

If you are using Gradle 5.x or later, add this to your dependencies

implementation platform('com.google.cloud:libraries-bom:20.9.0')

compile 'com.google.cloud:google-cloud-secretmanager'

If you are using Gradle without BOM, add this to your dependencies

compile 'com.google.cloud:google-cloud-secretmanager:1.7.0'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-secretmanager" % "1.7.0"

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Secret Management APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Secret Management API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Secret Management API enabled.

Follow these instructions to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud SDK and running the following commands in command line:
gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-secretmanager library. See the Quickstart section
to add google-cloud-secretmanager as a dependency in your code.

About Secret Management

Secret Management allows you to encrypt, store, manage, and audit infrastructure and application-level secrets.

See the Secret Management client library docs to learn how to
use this Secret Management Client Library.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
Access Secret Version	source code
Add Secret Version	source code
Create Secret	source code
Delete Secret	source code
Destroy Secret Version	source code
Disable Secret Version	source code
Enable Secret Version	source code
Get Secret	source code
Get Secret Version	source code
Iam Grant Access	source code
Iam Revoke Access	source code
List Secret Versions	source code
List Secrets	source code
Quickstart	source code
Update Secret	source code

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Secret Management uses gRPC for the transport layer.

Supported Java Versions

Java 7 or above is required for using this client.

Google's Java client libraries,
Google Cloud Client Libraries
and
Google Cloud API Libraries,
follow the
Oracle Java SE support roadmap
(see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
from initial General Availability). If the minimum required JVM for a given
library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new
development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by
Oracle's Extended Support (which typically lasts 8 years from initial
General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long
term stable libraries that don't receive feature updates on a best efforts basis
as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use
Java 7, though apps might need to upgrade to current versions of the library
that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on
the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME
and on google-cloud-java.

Versioning

This library follows Semantic Versioning.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in
this project you agree to abide by its terms. See Code of Conduct for more
information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version	Status
Java 7
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.

dzou/java-secretmanager