Skip to content

Commit

Permalink
Move shamir's into public sdk/ space, fix titles
Browse files Browse the repository at this point in the history
This moves shamir's code into the public sdk/ space, encouraging the
reuse of this component by other external libraries. Also fixes the
titles of API and SDK READMEs.

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
  • Loading branch information
cipherboy committed Mar 7, 2024
1 parent 439d930 commit 01e2171
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 12 deletions.
11 changes: 6 additions & 5 deletions api/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Vault API
OpenBao API
=================

This provides the `github.com/openbao/openbao/api` package which contains code useful for interacting with a Vault server.
This provides the `github.com/openbao/openbao/api` package which contains code useful for interacting with an OpenBao or Vault server.

For examples of how to use this module, see the [vault-examples](https://github.com/hashicorp/vault-examples) repo.
For a step-by-step walkthrough on using these client libraries, see the [developer quickstart](https://www.vaultproject.io/docs/get-started/developer-qs).
For examples of how to use this module, see the test suite contained
within OpenBao or [vault-examples](https://github.com/hashicorp/vault-examples)
repo from HashiCorp.

[![GoDoc](https://godoc.org/github.com/openbao/openbao/api?status.png)](https://godoc.org/github.com/openbao/openbao/api)
[![GoDoc](https://godoc.org/github.com/openbao/openbao/api?status.png)](https://godoc.org/github.com/openbao/openbao/api)
3 changes: 3 additions & 0 deletions changelog/181.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
sdk/helper/shamir: move Shamir's code into public SDK namespace to encourage external reuse
```
6 changes: 3 additions & 3 deletions sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Vault SDK libs
OpenBao SDK libs
=================

This package provides the `sdk` package which contains code useful for
developing Vault plugins.
developing OpenBao plugins.

Although we try not to break functionality, we reserve the right to reorganize
the code at will and may occasionally cause breaks if they are warranted. As
such we expect the tag of this module will stay less than `v1.0.0`.

For any major changes we will try to give advance notice in the CHANGES section
of Vault's CHANGELOG.md.
of OpenBao's CHANGELOG.md.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion vault/core.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ import (
"github.com/openbao/openbao/sdk/helper/jsonutil"
"github.com/openbao/openbao/sdk/helper/logging"
"github.com/openbao/openbao/sdk/helper/pathmanager"
"github.com/openbao/openbao/sdk/helper/shamir"
"github.com/openbao/openbao/sdk/logical"
"github.com/openbao/openbao/sdk/physical"
sr "github.com/openbao/openbao/serviceregistration"
"github.com/openbao/openbao/shamir"
"github.com/openbao/openbao/vault/cluster"
"github.com/openbao/openbao/vault/eventbus"
"github.com/openbao/openbao/vault/quotas"
Expand Down
2 changes: 1 addition & 1 deletion vault/generate_root.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
"github.com/openbao/openbao/helper/pgpkeys"
"github.com/openbao/openbao/sdk/helper/consts"
"github.com/openbao/openbao/sdk/helper/roottoken"
"github.com/openbao/openbao/shamir"
"github.com/openbao/openbao/sdk/helper/shamir"
)

const coreDROperationTokenPath = "core/dr-operation-token"
Expand Down
2 changes: 1 addition & 1 deletion vault/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (

"github.com/openbao/openbao/helper/namespace"
"github.com/openbao/openbao/helper/pgpkeys"
"github.com/openbao/openbao/shamir"
"github.com/openbao/openbao/sdk/helper/shamir"
)

// InitParams keeps the init function from being littered with too many
Expand Down
2 changes: 1 addition & 1 deletion vault/rekey.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ import (
"github.com/openbao/openbao/helper/pgpkeys"
"github.com/openbao/openbao/sdk/helper/consts"
"github.com/openbao/openbao/sdk/helper/jsonutil"
"github.com/openbao/openbao/sdk/helper/shamir"
"github.com/openbao/openbao/sdk/logical"
"github.com/openbao/openbao/sdk/physical"
"github.com/openbao/openbao/shamir"
"github.com/openbao/openbao/vault/seal"
)

Expand Down

0 comments on commit 01e2171

Please sign in to comment.