Giter VIP home page Giter VIP logo

java-kms's Introduction

Google Cloud Key Management Service Client for Java

Java idiomatic client for Cloud Key Management Service.

Maven Stability

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>16.4.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

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

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

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-kms</artifactId>
  <version>1.40.6</version>
</dependency>

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

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

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

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

compile 'com.google.cloud:google-cloud-kms:1.40.6'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-kms" % "1.40.6"

Authentication

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

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Cloud Key Management Service API enabled. You will need to enable billing to use Google Cloud Key Management Service. 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-kms library. See the Quickstart section to add google-cloud-kms as a dependency in your code.

About Cloud Key Management Service

Cloud Key Management Service a cloud-hosted key management service that lets you manage cryptographic keys for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256, RSA 2048, RSA 3072, RSA 4096, EC P256, and EC P384 cryptographic keys. Cloud KMS is integrated with Cloud IAM and Cloud Audit Logging so that you can manage permissions on individual keys and monitor how these are used. Use Cloud KMS to protect secrets and other sensitive data that you need to store in Google Cloud Platform.

See the Cloud Key Management Service client library docs to learn how to use this Cloud Key Management Service Client Library.

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Create Key Asymmetric Decrypt source code Open in Cloud Shell
Create Key Asymmetric Sign source code Open in Cloud Shell
Create Key Hsm source code Open in Cloud Shell
Create Key Labels source code Open in Cloud Shell
Create Key Ring source code Open in Cloud Shell
Create Key Rotation Schedule source code Open in Cloud Shell
Create Key Symmetric Encrypt Decrypt source code Open in Cloud Shell
Create Key Version source code Open in Cloud Shell
Decrypt Asymmetric source code Open in Cloud Shell
Decrypt Symmetric source code Open in Cloud Shell
Destroy Key Version source code Open in Cloud Shell
Disable Key Version source code Open in Cloud Shell
Enable Key Version source code Open in Cloud Shell
Encrypt Asymmetric source code Open in Cloud Shell
Encrypt Symmetric source code Open in Cloud Shell
Get Key Labels source code Open in Cloud Shell
Get Key Version Attestation source code Open in Cloud Shell
Get Public Key source code Open in Cloud Shell
Iam Add Member source code Open in Cloud Shell
Iam Get Policy source code Open in Cloud Shell
Iam Remove Member source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Restore Key Version source code Open in Cloud Shell
Sign Asymmetric source code Open in Cloud Shell
Update Key Add Rotation source code Open in Cloud Shell
Update Key Remove Labels source code Open in Cloud Shell
Update Key Remove Rotation source code Open in Cloud Shell
Update Key Set Primary source code Open in Cloud Shell
Update Key Update Labels source code Open in Cloud Shell
Verify Asymmetric Ec source code Open in Cloud Shell
Verify Asymmetric Rsa source code Open in Cloud Shell

Troubleshooting

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

Transport

Cloud Key Management Service uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

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 Kokoro CI
Java 8 Kokoro CI
Java 8 OSX Kokoro CI
Java 8 Windows Kokoro CI
Java 11 Kokoro CI

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

java-kms's People

Contributors

renovate-bot avatar yoshi-automation avatar chingor13 avatar kolea2 avatar release-please[bot] avatar jesselovelace avatar garrettjonesgoogle avatar pongad avatar andreamlin avatar daniel-sanche avatar elharo avatar white0ut avatar vam-google avatar athakor avatar yihanzhen avatar kurtisvg avatar walterhub avatar sethvargo avatar aozarov avatar averikitsch avatar bshaffer avatar busunkim96 avatar codyoss avatar dpebot avatar dzlier-gcp avatar jerjou avatar justinbeckwith avatar philcoakley avatar sduskis avatar elisheva-qlogic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.