SSH keys

Description and operation

General

Keys belong to your account, not to a team or a workspace. Every team where you are an active member accepts them. You add only the public half; its SHA-256 fingerprint is the key's _id.

One SSH key can be both an SSH key and a signing key; these are two entries. A key without a name takes the key's comment.

Tasks

Add an SSH key

Reason for the task: Clone and push over SSH.

Job set-up

• Access: you.
• References: POST /v1/keys.

Procedure

1. Copy your public key line, for example from ~/.ssh/id_ed25519.pub.

2. Add the key. Set key to the line from step 1.

   PythonCopy

   from kloudlite import Kloudlitekl = Kloudlite()k = kl.request("POST", "/v1/keys", body={"name": "laptop", "key": "ssh-ed25519 AAAA... you@laptop"})print(k["_id"])

   TypeScriptCopy

   import { Kloudlite } from "./index.ts";const kl = new Kloudlite();const k = (await kl.request("POST", "/v1/keys", { name: "laptop", key: "ssh-ed25519 AAAA... you@laptop" })) as { _id: string };console.log(k._id);

   GoCopy

   kl := kloudlite.New(kloudlite.Options{})var k map[string]anyerr := kl.Request("POST", "/v1/keys", kloudlite.RequestOptions{    Body: map[string]any{"name": "laptop", "key": "ssh-ed25519 AAAA... you@laptop"},    Out:  &k,})if err != nil {    log.Fatal(err)}fmt.Println(k["_id"])

   RubyCopy

   require_relative "kloudlite"kl = Kloudlite::Client.newputs kl.request("POST", "/v1/keys", body: { name: "laptop", key: "ssh-ed25519 AAAA... you@laptop" })["_id"]

   JavaCopy

   var kl = new Kloudlite();System.out.println(kl.request(new Kloudlite.RawRequest().method("POST").path("/v1/keys")    .body("{\"name\":\"laptop\",\"key\":\"ssh-ed25519 AAAA... you@laptop\"}")));

   CLICopy

   kloudlite request POST /v1/keys --body '{"name": "laptop", "key": "ssh-ed25519 AAAA... you@laptop"}'

Close-out

1. Make sure that the _id equals the fingerprint from ssh-keygen -lf ~/.ssh/id_ed25519.pub.

Add a signing key

Reason for the task: Show your commits as verified.

Job set-up

• Access: you.
• References: POST /v1/keys.

Procedure

1. Set git to sign with SSH. Skip this step for an OpenPGP key.

   CLICopy

   git config gpg.format ssh

2. Add the key with signing set to true. For OpenPGP, set key to the output of gpg --armor --export.

   PythonCopy

   kl.request("POST", "/v1/keys", body={"name": "laptop signing", "key": "ssh-ed25519 AAAA... you@laptop", "signing": True})

   TypeScriptCopy

   await kl.request("POST", "/v1/keys", { name: "laptop signing", key: "ssh-ed25519 AAAA... you@laptop", signing: true });

   GoCopy

   err := kl.Request("POST", "/v1/keys", kloudlite.RequestOptions{    Body: map[string]any{"name": "laptop signing", "key": "ssh-ed25519 AAAA... you@laptop", "signing": true},})if err != nil {    log.Fatal(err)}

   RubyCopy

   kl.request("POST", "/v1/keys", body: { name: "laptop signing", key: "ssh-ed25519 AAAA... you@laptop", signing: true })

   JavaCopy

   kl.request(new Kloudlite.RawRequest().method("POST").path("/v1/keys")    .body("{\"name\":\"laptop signing\",\"key\":\"ssh-ed25519 AAAA... you@laptop\",\"signing\":true}"));

   CLICopy

   kloudlite request POST /v1/keys --body '{"name": "laptop signing", "key": "ssh-ed25519 AAAA... you@laptop", "signing": true}'

Close-out

1. Show your signing keys with kind=signing as in task 003. Make sure that the new _id starts with sign:.

Show your keys

Reason for the task: List the keys of your account.

Job set-up

• Access: you.
• References: GET /v1/keys.

Procedure

1. Show the keys. Add the query kind=signing to show signing keys instead.

   PythonCopy

   for k in kl.request("GET", "/v1/keys"):    print(k["_id"], k["name"])

   TypeScriptCopy

   const keys = (await kl.request("GET", "/v1/keys")) as { _id: string; name: string }[];for (const k of keys) console.log(k._id, k.name);

   GoCopy

   var keys []map[string]anyif err := kl.Request("GET", "/v1/keys", kloudlite.RequestOptions{Out: &keys}); err != nil {    log.Fatal(err)}for _, k := range keys {    fmt.Println(k["_id"], k["name"])}

   RubyCopy

   kl.request("GET", "/v1/keys").each { |k| puts "#{k["_id"]} #{k["name"]}" }

   JavaCopy

   System.out.println(kl.request("GET", "/v1/keys"));

   CLICopy

   kloudlite request GET /v1/keys

Close-out

1. Make sure that each key in the list is still in use.

Remove a key

Reason for the task: Revoke a key that you no longer use.

Job set-up

• Access: you.
• References: DELETE /v1/keys/{*id}.

Procedure

1. Find the _id of the key as in task 003.

2. Remove the key. Replace SHA256:ID with its _id.

   PythonCopy

   kl.request("DELETE", "/v1/keys/SHA256:ID")

   TypeScriptCopy

   await kl.request("DELETE", "/v1/keys/SHA256:ID");

   GoCopy

   if err := kl.Request("DELETE", "/v1/keys/SHA256:ID", kloudlite.RequestOptions{}); err != nil {    log.Fatal(err)}

   RubyCopy

   kl.request("DELETE", "/v1/keys/SHA256:ID")

   JavaCopy

   kl.request("DELETE", "/v1/keys/SHA256:ID");

   CLICopy

   kloudlite request DELETE /v1/keys/SHA256:ID

Close-out

1. Show the keys. Make sure that the _id is gone.

Troubleshooting