chore: cleanup unneeded device storage methods (#399)
BREAKING CHANGE, removes methods from DeviceAuthorizationStorage: - GetDeviceAuthorizationByUserCode - CompleteDeviceAuthorization - DenyDeviceAuthorization The methods are now moved to examples as something similar can be userful for implementers.
This commit is contained in:
parent
d5a9bd6d0e
commit
e8262cbf1f
3 changed files with 16 additions and 14 deletions
|
@ -1,6 +1,7 @@
|
||||||
package exampleop
|
package exampleop
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
@ -16,6 +17,18 @@ import (
|
||||||
type deviceAuthenticate interface {
|
type deviceAuthenticate interface {
|
||||||
CheckUsernamePasswordSimple(username, password string) error
|
CheckUsernamePasswordSimple(username, password string) error
|
||||||
op.DeviceAuthorizationStorage
|
op.DeviceAuthorizationStorage
|
||||||
|
|
||||||
|
// GetDeviceAuthorizationByUserCode resturns the current state of the device authorization flow,
|
||||||
|
// identified by the user code.
|
||||||
|
GetDeviceAuthorizationByUserCode(ctx context.Context, userCode string) (*op.DeviceAuthorizationState, error)
|
||||||
|
|
||||||
|
// CompleteDeviceAuthorization marks a device authorization entry as Completed,
|
||||||
|
// identified by userCode. The Subject is added to the state, so that
|
||||||
|
// GetDeviceAuthorizatonState can use it to create a new Access Token.
|
||||||
|
CompleteDeviceAuthorization(ctx context.Context, userCode, subject string) error
|
||||||
|
|
||||||
|
// DenyDeviceAuthorization marks a device authorization entry as Denied.
|
||||||
|
DenyDeviceAuthorization(ctx context.Context, userCode string) error
|
||||||
}
|
}
|
||||||
|
|
||||||
type deviceLogin struct {
|
type deviceLogin struct {
|
||||||
|
|
|
@ -16,6 +16,7 @@ import (
|
||||||
"github.com/muhlemmer/gu"
|
"github.com/muhlemmer/gu"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
"github.com/zitadel/oidc/v3/example/server/storage"
|
||||||
"github.com/zitadel/oidc/v3/pkg/oidc"
|
"github.com/zitadel/oidc/v3/pkg/oidc"
|
||||||
"github.com/zitadel/oidc/v3/pkg/op"
|
"github.com/zitadel/oidc/v3/pkg/op"
|
||||||
)
|
)
|
||||||
|
@ -304,7 +305,7 @@ func BenchmarkNewUserCode(b *testing.B) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDeviceAccessToken(t *testing.T) {
|
func TestDeviceAccessToken(t *testing.T) {
|
||||||
storage := testProvider.Storage().(op.DeviceAuthorizationStorage)
|
storage := testProvider.Storage().(*storage.Storage)
|
||||||
storage.StoreDeviceAuthorization(context.Background(), "native", "qwerty", "yuiop", time.Now().Add(time.Minute), []string{"foo"})
|
storage.StoreDeviceAuthorization(context.Background(), "native", "qwerty", "yuiop", time.Now().Add(time.Minute), []string{"foo"})
|
||||||
storage.CompleteDeviceAuthorization(context.Background(), "yuiop", "tim")
|
storage.CompleteDeviceAuthorization(context.Background(), "yuiop", "tim")
|
||||||
|
|
||||||
|
@ -329,7 +330,7 @@ func TestDeviceAccessToken(t *testing.T) {
|
||||||
func TestCheckDeviceAuthorizationState(t *testing.T) {
|
func TestCheckDeviceAuthorizationState(t *testing.T) {
|
||||||
now := time.Now()
|
now := time.Now()
|
||||||
|
|
||||||
storage := testProvider.Storage().(op.DeviceAuthorizationStorage)
|
storage := testProvider.Storage().(*storage.Storage)
|
||||||
storage.StoreDeviceAuthorization(context.Background(), "native", "pending", "pending", now.Add(time.Minute), []string{"foo"})
|
storage.StoreDeviceAuthorization(context.Background(), "native", "pending", "pending", now.Add(time.Minute), []string{"foo"})
|
||||||
storage.StoreDeviceAuthorization(context.Background(), "native", "denied", "denied", now.Add(time.Minute), []string{"foo"})
|
storage.StoreDeviceAuthorization(context.Background(), "native", "denied", "denied", now.Add(time.Minute), []string{"foo"})
|
||||||
storage.StoreDeviceAuthorization(context.Background(), "native", "completed", "completed", now.Add(time.Minute), []string{"foo"})
|
storage.StoreDeviceAuthorization(context.Background(), "native", "completed", "completed", now.Add(time.Minute), []string{"foo"})
|
||||||
|
|
|
@ -182,18 +182,6 @@ type DeviceAuthorizationStorage interface {
|
||||||
// GetDeviceAuthorizatonState returns the current state of the device authorization flow in the database.
|
// GetDeviceAuthorizatonState returns the current state of the device authorization flow in the database.
|
||||||
// The method is polled untill the the authorization is eighter Completed, Expired or Denied.
|
// The method is polled untill the the authorization is eighter Completed, Expired or Denied.
|
||||||
GetDeviceAuthorizatonState(ctx context.Context, clientID, deviceCode string) (*DeviceAuthorizationState, error)
|
GetDeviceAuthorizatonState(ctx context.Context, clientID, deviceCode string) (*DeviceAuthorizationState, error)
|
||||||
|
|
||||||
// GetDeviceAuthorizationByUserCode resturn the current state of the device authorization flow,
|
|
||||||
// identified by the user code.
|
|
||||||
GetDeviceAuthorizationByUserCode(ctx context.Context, userCode string) (*DeviceAuthorizationState, error)
|
|
||||||
|
|
||||||
// CompleteDeviceAuthorization marks a device authorization entry as Completed,
|
|
||||||
// identified by userCode. The Subject is added to the state, so that
|
|
||||||
// GetDeviceAuthorizatonState can use it to create a new Access Token.
|
|
||||||
CompleteDeviceAuthorization(ctx context.Context, userCode, subject string) error
|
|
||||||
|
|
||||||
// DenyDeviceAuthorization marks a device authorization entry as Denied.
|
|
||||||
DenyDeviceAuthorization(ctx context.Context, userCode string) error
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func assertDeviceStorage(s Storage) (DeviceAuthorizationStorage, error) {
|
func assertDeviceStorage(s Storage) (DeviceAuthorizationStorage, error) {
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue