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.

Sign up for GitHub

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

SM-1082: Add SM State to Go SDK Wrapper #559

Merged
merged 8 commits into from
Feb 15, 2024
Merged

SM-1082: Add SM State to Go SDK Wrapper #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
80a9fcb
SM-1082: Add SM state to bitwarden_client.go
coltonhurst Jan 29, 2024
c09e13f
SM-1082: Use camelCase
coltonhurst Jan 29, 2024
a4c5cef
Merge branch 'main' into sm/sm-1082
coltonhurst Jan 31, 2024
5cbd721
Merge branch 'main' into sm/sm-1082
coltonhurst Feb 6, 2024
bd86086
SM-1082: Mark statePath as optional in Go wrapper
coltonhurst Feb 6, 2024
ac94ce9
SM-1082: Fix spelling error
coltonhurst Feb 6, 2024
4f8a6c6
Merge branch 'main' into sm/sm-1082
coltonhurst Feb 6, 2024
6d50e85
SM-1082: Update Go readme
coltonhurst Feb 7, 2024
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
6 changes: 4 additions & 2 deletions languages/go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ bitwardenClient, _ := sdk.NewBitwardenClient(&apiURL, &identityURL)

### Login

To login using an access token:
To login using an access token. Define some `statePath` and pass it to use state, or pass `nil` instead to not use state.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fairly cryptic, can we rewrite it to something like

Login using an access token, accepts an optional statePath which allows you to persist login sessions across multiple runs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Colton is out, I'm going to merge this PR now to get it in the hands of our vendor and and create a separate PR with these comment updates.


```go
apiKeyLogin, err := bitwardenClient.AccessTokenLogin(accessToken)
statePath := os.Getenv("STATE_PATH")

err := bitwardenClient.AccessTokenLogin(accessToken, &statePath)
```

---
Expand Down
4 changes: 2 additions & 2 deletions languages/go/bitwarden_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ func NewBitwardenClient(apiURL *string, identityURL *string) (*BitwardenClient,
}, nil
}

func (c *BitwardenClient) AccessTokenLogin(accessToken string) error {
req := AccessTokenLoginRequest{AccessToken: accessToken}
func (c *BitwardenClient) AccessTokenLogin(accessToken string, statePath *string) error {
dani-garcia marked this conversation as resolved.
Show resolved Hide resolved
req := AccessTokenLoginRequest{AccessToken: accessToken, StateFile: statePath}
command := Command{AccessTokenLogin: &req}

responseStr, err := c.commandRunner.RunCommand(command)
Expand Down
6 changes: 5 additions & 1 deletion languages/go/example/example.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@ func main() {
organizationIDStr := os.Getenv("ORGANIZATION_ID")
projectName := os.Getenv("PROJECT_NAME")

// Configuring the statePath is optional, pass nil
// in AccessTokenLogin() to not use state
Comment on lines +22 to +23
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this comment is more descriptive.

Suggested change
// Configuring the statePath is optional, pass nil
// in AccessTokenLogin() to not use state
// Optional state file to persist access tokens between runs.

statePath := os.Getenv("STATE_PATH")

if projectName == "" {
projectName = "NewTestProject" // default value
}

err := bitwardenClient.AccessTokenLogin(accessToken)
err := bitwardenClient.AccessTokenLogin(accessToken, &statePath)
Thomas-Avery marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
panic(err)
}
Expand Down
Loading