Merge pull request #18007 from rook/mergify/bp/release-1.20/pr-17965

csi: do not log peer bootstrap token secret (backport #17965)

pkg/operator/ceph/csi/peermap/config.go

@@ -348,7 +348,10 @@ func decodePeerToken(token string) (*cephclient.PeerToken, error) {
 		return nil, errors.Wrap(err, "failed to unmarshal decoded token")
 	}
 
-	logger.Debugf("peer cluster info %+v", decodedTokenToGo)
+	// Log only the non-sensitive fields; the token embeds the peer cluster's
+	// cephx auth key (decodedTokenToGo.Key), which must never be logged.
+	logger.Debugf("decoded peer cluster info fsid=%q clientID=%q monHost=%q namespace=%q",
+		decodedTokenToGo.ClusterFSID, decodedTokenToGo.ClientID, decodedTokenToGo.MonHost, decodedTokenToGo.Namespace)
 
 	return &decodedTokenToGo, nil
 }

pkg/operator/ceph/csi/peermap/config_test.go

@@ -17,6 +17,7 @@ limitations under the License.
 package peermap
 
 import (
+	"bytes"
 	"context"
 	"fmt"
 	"os"
@@ -26,6 +27,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/coreos/pkg/capnslog"
 	cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
 	"github.com/rook/rook/pkg/client/clientset/versioned/scheme"
 	"github.com/rook/rook/pkg/clusterd"
@@ -406,6 +408,23 @@ func TestDecodePeerToken(t *testing.T) {
 	assert.Error(t, err)
 }
 
+func TestDecodePeerTokenDoesNotLogSecret(t *testing.T) {
+	// The peer token embeds the peer cluster's cephx auth key, which must never
+	// be written to the operator logs, even at debug level.
+	logBuf := bytes.NewBuffer([]byte{})
+	capnslog.SetFormatter(capnslog.NewLogFormatter(logBuf, "", 0))
+	capnslog.SetGlobalLogLevel(capnslog.DEBUG)
+
+	decodedToken, err := decodePeerToken(fakeTokenPeer1)
+	assert.NoError(t, err)
+
+	logOutput := logBuf.String()
+	assert.NotEmpty(t, decodedToken.Key)
+	assert.NotContains(t, logOutput, decodedToken.Key)
+	// The non-sensitive fields are still useful for diagnostics.
+	assert.Contains(t, logOutput, decodedToken.Namespace)
+}
+
 func TestCreateOrUpdateConfig(t *testing.T) {
 	t.Setenv("POD_NAME", "rook-ceph-operator")
 	t.Setenv("POD_NAMESPACE", ns)