Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Shamir's to shared sdk/, fix titles in API & SDK READMEs #181

Merged
merged 1 commit into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading