Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corbado/corbado-go
Add passkeys to your Go application with the Corbado Go SDK.
https://github.com/corbado/corbado-go
biometric corbado corbado-sdk faceid fido fido2 go go-sdk golang passkey passkeys sdk touchid webauthn
Last synced: about 2 months ago
JSON representation
Add passkeys to your Go application with the Corbado Go SDK.
- Host: GitHub
- URL: https://github.com/corbado/corbado-go
- Owner: corbado
- License: mit
- Created: 2023-11-15T14:37:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:08:19.000Z (3 months ago)
- Last Synced: 2024-10-25T20:03:58.907Z (3 months ago)
- Topics: biometric, corbado, corbado-sdk, faceid, fido, fido2, go, go-sdk, golang, passkey, passkeys, sdk, touchid, webauthn
- Language: Go
- Homepage: https://www.corbado.com/passkeys/golang
- Size: 261 KB
- Stars: 14
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Corbado Go SDK
[](https://pkg.go.dev/github.com/corbado/corbado-go)
[](https://opensource.org/licenses/MIT)
[](https://github.com/corbado/corbado-go/actions?query=workflow%3Atests)
[](https://goreportcard.com/report/github.com/corbado/corbado-go)
[](https://apireference.cloud.corbado.io/backendapi/)
[](https://join.slack.com/t/corbado/shared_invite/zt-1b7867yz8-V~Xr~ngmSGbt7IA~g16ZsQ)
The [Corbado](https://www.corbado.com) Go SDK provides convenient access to the [Corbado Backend API](https://apireference.cloud.corbado.io/backendapi-v2/) from applications written in the Go language.
:warning: The Corbado Go SDK is commonly referred to as a private client, specifically designed for usage within closed backend applications. This particular SDK should exclusively be utilized in such environments, as it is crucial to ensure that the API secret remains strictly confidential and is never shared.
:rocket: [Getting started](#rocket-getting-started) | :hammer_and_wrench: [Services](#hammer_and_wrench-services) | :books: [Advanced](#books-advanced) | :speech_balloon: [Support & Feedback](#speech_balloon-support--feedback)
## :rocket: Getting started
### Requirements
- Go 1.18 or later
### Installation
Use the following command to install the Corbado Go SDK:
```bash
go get github.com/corbado/corbado-go/v2
```
### Usage
To create a Corbado Go SDK instance you need to provide your `Project ID`, `API secret` , `Frontend API` and `Backend API` URLs which can be found at the [Developer Panel](https://app.corbado.com).
```Go
package main
import (
"github.com/corbado/corbado-go"
)
func main() {
config, err := corbado.NewConfig("", "", "", "")
if err != nil {
panic(err)
}
sdk, err := corbado.NewSDK(config)
if err != nil {
panic(err)
}
}
```
### Examples
A list of examples can be found in the [examples](/examples) directory. [Integration tests](tests/integration) are good examples as well.
## :hammer_and_wrench: Services
The Corbado Go SDK provides the following services:
- `Sessions` for managing sessions ([examples](examples/stdlib/session))
- `Users` for managing users ([examples](tests/integration/user))
- `Identifiers` for managing identifiers ([examples](tests/integration/identifier))
To use a specific service, such as `Users`, invoke it as shown below:
```Go
user, err := sdk.Users().Get(context.Background(), "usr-12345679")
if err != nil {
panic(err)
}
```
## :books: Advanced
### Error handling
The Corbado Go SDK uses Go standard error handling (error interface). If the Backend API returns a HTTP status code other than 200, the Corbado Go SDK returns a `ServerError` error (which implements the error interface):
```Go
package main
import (
"context"
"fmt"
"github.com/corbado/corbado-go"
)
func main() {
config, err := corbado.NewConfig("", "", "", "")
if err != nil {
panic(err)
}
sdk, err := corbado.NewSDK(config)
if err != nil {
panic(err)
}
// Try to get non-existing user with ID 'usr-123456789'
user, err := sdk.Users().Get(context.Background(), "usr-123456789")
if err != nil {
if serverErr := corbado.AsServerError(err); serverErr != nil {
// Show HTTP status code (400 in this case)
fmt.Println(serverErr.HTTPStatusCode)
// Show request ID (can be used in developer panel to look up the full request
// and response, see https://app.corbado.com/app/logs/requests)
fmt.Println(serverErr.RequestData.RequestID)
// Show runtime of request in seconds (server side)
fmt.Println(serverErr.Runtime)
// Show validation error messages (server side validation in case of HTTP
// status code 400 (Bad Request))
fmt.Printf("%+v\n", serverErr.Validation)
} else {
// Handle other errors
panic(err)
}
return
}
fmt.Println(user.userID)
}
```
## :speech_balloon: Support & Feedback
### Report an issue
If you encounter any bugs or have suggestions, please [open an issue](https://github.com/corbado/corbado-go/issues/new).
### Slack channel
Join our Slack channel to discuss questions or ideas with the Corbado team and other developers.
[](https://join.slack.com/t/corbado/shared_invite/zt-1b7867yz8-V~Xr~ngmSGbt7IA~g16ZsQ)
### Email
You can also reach out to us via email at [email protected].
### Vulnerability reporting
Please report suspected security vulnerabilities in private to [email protected]. Please do NOT create publicly viewable issues for suspected security vulnerabilities.