From 88f5c0d057b88b8412b7d69009b357f8211f8bba Mon Sep 17 00:00:00 2001 From: Marton Soos Date: Fri, 14 Aug 2020 14:40:49 +0200 Subject: [PATCH] Add godoc with note that setup codes cannot be used to decrypt --- pkg/secrethub/credentials/setup_code.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pkg/secrethub/credentials/setup_code.go b/pkg/secrethub/credentials/setup_code.go index f99a11ef..51f36070 100644 --- a/pkg/secrethub/credentials/setup_code.go +++ b/pkg/secrethub/credentials/setup_code.go @@ -13,6 +13,8 @@ type SetupCode struct { code string } +// Provide implements the Provider interface for the setup code. +// Note that no decrypter is ever returned as setup codes cannot be used to decrypt secrets. func (s *SetupCode) Provide(client *httpclient.Client) (auth.Authenticator, Decrypter, error) { return s, nil, nil }