Set secret with issuer (#9)

nhatthm · Mar 20, 2024 · b8364bf · b8364bf
1 parent e161f78
commit b8364bf
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 25 deletions.
diff --git a/keyring/totp.go b/keyring/totp.go
@@ -49,7 +49,7 @@ func (s *TOTPSecretProvider) TOTPSecret(ctx context.Context) otp.TOTPSecret {
 }
 
 // SetTOTPSecret persists the TOTP secret to the keyring.
-func (s *TOTPSecretProvider) SetTOTPSecret(ctx context.Context, secret otp.TOTPSecret) error {
+func (s *TOTPSecretProvider) SetTOTPSecret(ctx context.Context, secret otp.TOTPSecret, _ string) error {
 	if s.account == "" {
 		return nil
 	}

diff --git a/keyring/totp_test.go b/keyring/totp_test.go
@@ -120,7 +120,7 @@ func TestTOTPSecretProvider_SetTOTPSecret(t *testing.T) {
 				keyring.WithLogger(ctxd.NoOpLogger{}),
 			)
 
-			err := s.SetTOTPSecret(context.Background(), "secret")
+			err := s.SetTOTPSecret(context.Background(), "secret", "issuer")
 
 			if tc.expectedError == "" {
 				require.NoError(t, err)

diff --git a/mock/totp_secret_provider.go b/mock/totp_secret_provider.go
diff --git a/mock/totp_secret_setter.go b/mock/totp_secret_setter.go
diff --git a/totp.go b/totp.go
@@ -45,7 +45,7 @@ func (s TOTPSecret) TOTPSecret(context.Context) TOTPSecret {
 }
 
 // SetTOTPSecret sets the TOTP secret.
-func (s TOTPSecret) SetTOTPSecret(context.Context, TOTPSecret) error {
+func (s TOTPSecret) SetTOTPSecret(context.Context, TOTPSecret, string) error {
 	return ErrTOTPSecretReadOnly
 }
 
@@ -64,7 +64,7 @@ func (s totpSecreteSurrogate) TOTPSecret(context.Context) TOTPSecret {
 }
 
 // SetTOTPSecret sets the TOTP secret.
-func (s *totpSecreteSurrogate) SetTOTPSecret(_ context.Context, secret TOTPSecret) error {
+func (s *totpSecreteSurrogate) SetTOTPSecret(_ context.Context, secret TOTPSecret, _ string) error {
 	s.secret = secret
 
 	return nil
@@ -91,7 +91,7 @@ type TOTPSecretGetter interface {
 
 // TOTPSecretSetter is an interface that sets a TOTP secret.
 type TOTPSecretSetter interface {
-	SetTOTPSecret(ctx context.Context, secret TOTPSecret) error
+	SetTOTPSecret(ctx context.Context, secret TOTPSecret, issuer string) error
 }
 
 // TOTPSecretDeleter is an interface that deletes a TOTP secret.
@@ -145,9 +145,9 @@ func (ps TOTPSecretProviders) TOTPSecret(ctx context.Context) TOTPSecret {
 }
 
 // SetTOTPSecret sets the TOTP secret.
-func (ps TOTPSecretProviders) SetTOTPSecret(ctx context.Context, secret TOTPSecret) error {
+func (ps TOTPSecretProviders) SetTOTPSecret(ctx context.Context, secret TOTPSecret, issuer string) error {
 	for _, p := range ps {
-		if err := p.SetTOTPSecret(ctx, secret); err != nil {
+		if err := p.SetTOTPSecret(ctx, secret, issuer); err != nil {
 			return err
 		}
 	}
@@ -195,7 +195,7 @@ func (e envTOTPSecret) TOTPSecret(_ context.Context) TOTPSecret {
 }
 
 // SetTOTPSecret sets the TOTP secret to the environment.
-func (e envTOTPSecret) SetTOTPSecret(_ context.Context, secret TOTPSecret) error {
+func (e envTOTPSecret) SetTOTPSecret(_ context.Context, secret TOTPSecret, _ string) error {
 	return os.Setenv(string(e), string(secret))
 }
 

diff --git a/totp_test.go b/totp_test.go
@@ -47,7 +47,7 @@ func TestTOTPSecret_TOTPSecret(t *testing.T) {
 
 	assert.Equal(t, "secret", string(p.TOTPSecret(ctx)))
 
-	err := p.SetTOTPSecret(ctx, "changed")
+	err := p.SetTOTPSecret(ctx, "changed", "")
 	require.ErrorIs(t, err, otp.ErrTOTPSecretReadOnly)
 
 	assert.Equal(t, "secret", string(p.TOTPSecret(ctx)))
@@ -72,7 +72,7 @@ func TestTOTPSecretFromEnv(t *testing.T) {
 
 	assert.Equal(t, "secret", string(p.TOTPSecret(ctx)))
 
-	err := p.SetTOTPSecret(ctx, "changed")
+	err := p.SetTOTPSecret(ctx, "changed", "")
 	require.NoError(t, err)
 
 	assert.Equal(t, "changed", string(p.TOTPSecret(ctx)))
@@ -140,23 +140,23 @@ func TestChainTOTPSecretProviders_SetSecret(t *testing.T) {
 		{
 			scenario: "failed",
 			mockProvider: mock.MockTOTPSecretProvider(func(p *mock.TOTPSecretProvider) {
-				p.On("SetTOTPSecret", mock.Anything, otp.TOTPSecret("secret")).
+				p.On("SetTOTPSecret", mock.Anything, otp.TOTPSecret("secret"), "issuer").
 					Return(assert.AnError)
 			}),
 			expectedError: `assert.AnError general error for testing`,
 		},
 		{
 			scenario: "readonly",
 			mockProvider: mock.MockTOTPSecretProvider(func(p *mock.TOTPSecretProvider) {
-				p.On("SetTOTPSecret", mock.Anything, otp.TOTPSecret("secret")).
+				p.On("SetTOTPSecret", mock.Anything, otp.TOTPSecret("secret"), "issuer").
 					Return(otp.ErrTOTPSecretReadOnly)
 			}),
 			expectedError: `totp secret is read-only`,
 		},
 		{
 			scenario: "success",
 			mockProvider: mock.MockTOTPSecretProvider(func(p *mock.TOTPSecretProvider) {
-				p.On("SetTOTPSecret", mock.Anything, otp.TOTPSecret("secret")).
+				p.On("SetTOTPSecret", mock.Anything, otp.TOTPSecret("secret"), "issuer").
 					Return(nil)
 			}),
 		},
@@ -169,7 +169,7 @@ func TestChainTOTPSecretProviders_SetSecret(t *testing.T) {
 
 			p := otp.ChainTOTPSecretProviders(tc.mockProvider(t))
 
-			err := p.SetTOTPSecret(context.Background(), "secret")
+			err := p.SetTOTPSecret(context.Background(), "secret", "issuer")
 
 			if tc.expectedError == "" {
 				require.NoError(t, err)
@@ -245,7 +245,7 @@ func TestChainTOTPSecretProviders(t *testing.T) { //nolint: paralleltest
 
 	assert.Equal(t, "secret", string(p.TOTPSecret(ctx)))
 
-	err := p.SetTOTPSecret(ctx, "changed")
+	err := p.SetTOTPSecret(ctx, "changed", "")
 	require.NoError(t, err)
 
 	// Change secret.