Skip to content

Commit

Permalink
Clarify README description
Browse files Browse the repository at this point in the history
  • Loading branch information
andreaso committed Dec 9, 2023
1 parent 59e89df commit 66a50e9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ Python library for using [HashiCorp Vault][1]'s [Transit Engine][2] to
manage a GitHub App's private RSA key. More precisely, the library
provides the following pieces of functionality.

* Perform initial import of the App's private key into Vault
* Have Vault sign the needed JWT and then request a GitHub Access Token
* Perform initial one-way import of the App's private key into Vault
* Issue (short-lived) GitHub Access Token
* Have Vault sign a JWT using the App's private key
* Exchange that JWT for a GitHub Access Token

Conceptually Vault here fills the role of an HSM or a Cloud KMS.

See [Authenticating as a GitHub App installation (GitHub Docs)][3] for context.

Expand Down

0 comments on commit 66a50e9

Please sign in to comment.