Refactor key provider interfaces in JWT utilities

sreya · sreya · commit 54214e29aedc · 2024-10-03T08:10:24.000Z
diff --git a/coderd/jwtutils/jwe.go b/coderd/jwtutils/jwe.go
@@ -16,16 +16,16 @@ const (
 	encryptContentAlgo = jose.A256GCM
 )
 
-type EncryptKeyer interface {
+type EncryptKeyProvider interface {
 	EncryptingKey(ctx context.Context) (id string, key interface{}, err error)
 }
 
-type DecryptKeyer interface {
+type DecryptKeyProvider interface {
 	DecryptingKey(ctx context.Context, id string) (key interface{}, err error)
 }
 
 // Encrypt encrypts a token and returns it as a string.
-func Encrypt(ctx context.Context, e EncryptKeyer, claims Claims) (string, error) {
+func Encrypt(ctx context.Context, e EncryptKeyProvider, claims Claims) (string, error) {
 	id, key, err := e.EncryptingKey(ctx)
 	if err != nil {
 		return "", xerrors.Errorf("get signing key: %w", err)
@@ -72,7 +72,7 @@ type DecryptOptions struct {
 }
 
 // Decrypt decrypts the token using the provided key. It unmarshals into the provided claims.
-func Decrypt(ctx context.Context, d DecryptKeyer, token string, claims Claims, opts ...func(*DecryptOptions)) error {
+func Decrypt(ctx context.Context, d DecryptKeyProvider, token string, claims Claims, opts ...func(*DecryptOptions)) error {
 	options := DecryptOptions{
 		RegisteredClaims: jwt.Expected{
 			Time: time.Now(),
diff --git a/coderd/jwtutils/jws.go b/coderd/jwtutils/jws.go
@@ -24,16 +24,16 @@ const (
 	signingAlgo = jose.HS512
 )
 
-type SignKeyer interface {
+type SigningKeyProvider interface {
 	SigningKey(ctx context.Context) (id string, key interface{}, err error)
 }
 
-type VerifyKeyer interface {
+type VerifyKeyProvider interface {
 	VerifyingKey(ctx context.Context, id string) (key interface{}, err error)
 }
 
 // Sign signs a token and returns it as a string.
-func Sign(ctx context.Context, s SignKeyer, claims Claims) (string, error) {
+func Sign(ctx context.Context, s SigningKeyProvider, claims Claims) (string, error) {
 	id, key, err := s.SigningKey(ctx)
 	if err != nil {
 		return "", xerrors.Errorf("get signing key: %w", err)
@@ -78,7 +78,7 @@ type VerifyOptions struct {
 }
 
 // Verify verifies that a token was signed by the provided key. It unmarshals into the provided claims.
-func Verify(ctx context.Context, v VerifyKeyer, token string, claims Claims, opts ...func(*VerifyOptions)) error {
+func Verify(ctx context.Context, v VerifyKeyProvider, token string, claims Claims, opts ...func(*VerifyOptions)) error {
 	options := VerifyOptions{
 		RegisteredClaims: jwt.Expected{
 			Time: time.Now(),

Original file line number	Diff line number	Diff line change
`@@ -16,16 +16,16 @@ const (`
`16`	`16`	`encryptContentAlgo = jose.A256GCM`
`17`	`17`	`)`
`18`	`18`
`19`		`-type EncryptKeyer interface {`
	`19`	`+type EncryptKeyProvider interface {`
`20`	`20`	`EncryptingKey(ctx context.Context) (id string, key interface{}, err error)`
`21`	`21`	`}`
`22`	`22`
`23`		`-type DecryptKeyer interface {`
	`23`	`+type DecryptKeyProvider interface {`
`24`	`24`	`DecryptingKey(ctx context.Context, id string) (key interface{}, err error)`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`// Encrypt encrypts a token and returns it as a string.`
`28`		`-func Encrypt(ctx context.Context, e EncryptKeyer, claims Claims) (string, error) {`
	`28`	`+func Encrypt(ctx context.Context, e EncryptKeyProvider, claims Claims) (string, error) {`
`29`	`29`	`id, key, err := e.EncryptingKey(ctx)`
`30`	`30`	`if err != nil {`
`31`	`31`	`return "", xerrors.Errorf("get signing key: %w", err)`
`@@ -72,7 +72,7 @@ type DecryptOptions struct {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`// Decrypt decrypts the token using the provided key. It unmarshals into the provided claims.`
`75`		`-func Decrypt(ctx context.Context, d DecryptKeyer, token string, claims Claims, opts ...func(*DecryptOptions)) error {`
	`75`	`+func Decrypt(ctx context.Context, d DecryptKeyProvider, token string, claims Claims, opts ...func(*DecryptOptions)) error {`
`76`	`76`	`options := DecryptOptions{`
`77`	`77`	`RegisteredClaims: jwt.Expected{`
`78`	`78`	`Time: time.Now(),`
Original file line number	Diff line number	Diff line change
`@@ -24,16 +24,16 @@ const (`
`24`	`24`	`signingAlgo = jose.HS512`
`25`	`25`	`)`
`26`	`26`
`27`		`-type SignKeyer interface {`
	`27`	`+type SigningKeyProvider interface {`
`28`	`28`	`SigningKey(ctx context.Context) (id string, key interface{}, err error)`
`29`	`29`	`}`
`30`	`30`
`31`		`-type VerifyKeyer interface {`
	`31`	`+type VerifyKeyProvider interface {`
`32`	`32`	`VerifyingKey(ctx context.Context, id string) (key interface{}, err error)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`// Sign signs a token and returns it as a string.`
`36`		`-func Sign(ctx context.Context, s SignKeyer, claims Claims) (string, error) {`
	`36`	`+func Sign(ctx context.Context, s SigningKeyProvider, claims Claims) (string, error) {`
`37`	`37`	`id, key, err := s.SigningKey(ctx)`
`38`	`38`	`if err != nil {`
`39`	`39`	`return "", xerrors.Errorf("get signing key: %w", err)`
`@@ -78,7 +78,7 @@ type VerifyOptions struct {`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`// Verify verifies that a token was signed by the provided key. It unmarshals into the provided claims.`
`81`		`-func Verify(ctx context.Context, v VerifyKeyer, token string, claims Claims, opts ...func(*VerifyOptions)) error {`
	`81`	`+func Verify(ctx context.Context, v VerifyKeyProvider, token string, claims Claims, opts ...func(*VerifyOptions)) error {`
`82`	`82`	`options := VerifyOptions{`
`83`	`83`	`RegisteredClaims: jwt.Expected{`
`84`	`84`	`Time: time.Now(),`