Confidential Computing API: Node.js Client

Confidential Computing API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Confidential Computing API API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/confidentialcomputing

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the location where the Challenge will be
 *  used, in the format `projects/* /locations/*`.
 */
// const parent = 'abc123'
/**
 *  Required. The Challenge to be created. Currently this field can be empty as
 *  all the Challenge fields are set by the server.
 */
// const challenge = {}

// Imports the Confidentialcomputing library
const {ConfidentialComputingClient} =
  require('@google-cloud/confidentialcomputing').v1;

// Instantiates a client
const confidentialcomputingClient = new ConfidentialComputingClient();

async function callCreateChallenge() {
  // Construct request
  const request = {
    parent,
    challenge,
  };

  // Run request
  const response = await confidentialcomputingClient.createChallenge(request);
  console.log(response);
}

callCreateChallenge();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Confidential_computing.create_challenge	source code
Confidential_computing.verify_attestation	source code
Confidential_computing.create_challenge	source code
Confidential_computing.verify_attestation	source code
Quickstart	source code

The Confidential Computing API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/confidentialcomputing@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE