change interface/struct name

channelz/service/func_nonunix.go

@@ -22,7 +22,7 @@ package service
 
 import (
 	"google.golang.org/grpc/channelz"
-	channelzpb "google.golang.org/grpc/channelz/service_proto"
+	channelzpb "google.golang.org/grpc/channelz/grpc_channelz_v1"
 )
 
 func sockoptToProto(skopts *channelz.SocketOptionData) []*channelzpb.SocketOption {

channelz/service/service.go

@@ -135,15 +135,15 @@ func subChannelMetricToProto(cm *channelz.SubChannelMetric) *channelzpb.Subchann
 	return sc
 }
 
-func securityToProto(se credentials.SecurityValue) *channelzpb.Security {
+func securityToProto(se credentials.ChannelzSecurityValue) *channelzpb.Security {
 	switch v := se.(type) {
-	case *credentials.TLSSecurityValue:
+	case *credentials.TLSChannelzSecurityValue:
 		return &channelzpb.Security{Model: &channelzpb.Security_Tls_{Tls: &channelzpb.Security_Tls{
 			CipherSuite:       &channelzpb.Security_Tls_StandardName{StandardName: v.StandardName},
 			LocalCertificate:  v.LocalCertificate,
 			RemoteCertificate: v.RemoteCertificate,
 		}}}
-	case *credentials.OtherSecurityValue:
+	case *credentials.OtherChannelzSecurityValue:
 		otherSecurity := &channelzpb.Security_OtherSecurity{
 			Name: v.Name,
 		}

channelz/service/service_test.go

@@ -101,7 +101,7 @@ type dummySocket struct {
 	SocketOptions                    *channelz.SocketOptionData
 	localAddr                        net.Addr
 	remoteAddr                       net.Addr
-	Security                         credentials.SecurityValue
+	Security                         credentials.ChannelzSecurityValue
 	remoteName                       string
 }
 
@@ -196,12 +196,12 @@ func protoToTime(protoTime *channelzpb.SocketOptionTimeout) *unix.Timeval {
 	return timeout
 }
 
-func protoToSecurity(protoSecurity *channelzpb.Security) credentials.SecurityValue {
+func protoToSecurity(protoSecurity *channelzpb.Security) credentials.ChannelzSecurityValue {
 	switch v := protoSecurity.Model.(type) {
 	case *channelzpb.Security_Tls_:
-		return &credentials.TLSSecurityValue{StandardName: v.Tls.GetStandardName(), LocalCertificate: v.Tls.GetLocalCertificate(), RemoteCertificate: v.Tls.GetRemoteCertificate()}
+		return &credentials.TLSChannelzSecurityValue{StandardName: v.Tls.GetStandardName(), LocalCertificate: v.Tls.GetLocalCertificate(), RemoteCertificate: v.Tls.GetRemoteCertificate()}
 	case *channelzpb.Security_Other:
-		sv := &credentials.OtherSecurityValue{Name: v.Other.GetName()}
+		sv := &credentials.OtherChannelzSecurityValue{Name: v.Other.GetName()}
 		var x ptypes.DynamicAny
 		if err := ptypes.UnmarshalAny(v.Other.GetValue(), &x); err == nil {
 			sv.Value = x.Message
@@ -356,7 +356,7 @@ func (*OtherSecurityValue) ProtoMessage()    {}
 
 func init() {
 	// Ad-hoc registering the proto type here to facilitate UnmarshalAny of OtherSecurityValue.
-	proto.RegisterType((*OtherSecurityValue)(nil), "grpc.credentials.OtherSecurityValue")
+	proto.RegisterType((*OtherSecurityValue)(nil), "grpc.credentials.OtherChannelzSecurityValue")
 }
 
 func TestGetTopChannels(t *testing.T) {
@@ -596,18 +596,18 @@ func TestGetSocket(t *testing.T) {
 			},
 		},
 		{
-			Security: &credentials.TLSSecurityValue{
+			Security: &credentials.TLSChannelzSecurityValue{
 				StandardName:      "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
 				RemoteCertificate: []byte{48, 130, 2, 156, 48, 130, 2, 5, 160},
 			},
 		},
 		{
-			Security: &credentials.OtherSecurityValue{
+			Security: &credentials.OtherChannelzSecurityValue{
 				Name: "XXXX",
 			},
 		},
 		{
-			Security: &credentials.OtherSecurityValue{
+			Security: &credentials.OtherChannelzSecurityValue{
 				Name:  "YYYY",
 				Value: &OtherSecurityValue{LocalCertificate: []byte{1, 2, 3}, RemoteCertificate: []byte{4, 5, 6}},
 			},

channelz/types.go

@@ -284,7 +284,7 @@ type SocketInternalMetric struct {
 	// the original target name.
 	RemoteName    string
 	SocketOptions *SocketOptionData
-	Security      credentials.SecurityValue
+	Security      credentials.ChannelzSecurityValue
 }
 
 // Socket is the interface that should be satisfied in order to be tracked by

credentials/credentials.go

@@ -120,8 +120,8 @@ func (t TLSInfo) AuthType() string {
 }
 
 // GetSecurityValue returns security info requested by channelz.
-func (t TLSInfo) GetSecurityValue() SecurityValue {
-	v := &TLSSecurityValue{
+func (t TLSInfo) GetChannelzSecurityValue() ChannelzSecurityValue {
+	v := &TLSChannelzSecurityValue{
 		StandardName: cipherSuiteLookup[t.State.CipherSuite],
 	}
 	// Currently there's no way to get LocalCertificate info from tls package.
@@ -232,34 +232,36 @@ func NewServerTLSFromFile(certFile, keyFile string) (TransportCredentials, error
 	return NewTLS(&tls.Config{Certificates: []tls.Certificate{cert}}), nil
 }
 
-// ExtraSecurityInfo defines the interface that security protocols should implement in order
-// to provide security info to channelz.
-type ExtraSecurityInfo interface {
-	GetSecurityValue() SecurityValue
+// ChannelzSecurityInfo defines the interface that security protocols should implement
+// in order to provide security info to channelz.
+type ChannelzSecurityInfo interface {
+	GetSecurityValue() ChannelzSecurityValue
 }
 
-// SecurityValue defines the interface that GetSecurityValue() return value should
-// satisfy. This interface should only be satisfied by *TLSSecurityValue and
-// *OtherSecurityValue.
-type SecurityValue interface {
-	isSecurityValue()
+// ChannelzSecurityValue defines the interface that GetSecurityValue() return value
+// should satisfy. This interface should only be satisfied by *TLSChannelzSecurityValue
+// and *OtherChannelzSecurityValue.
+type ChannelzSecurityValue interface {
+	isChannelzSecurityValue()
 }
 
-// TLSSecurityValue defines the struct that TLS protocol should return from GetSecurityValue(),
-// containing security info like cipher and certificate used.
-type TLSSecurityValue struct {
+// TLSChannelzSecurityValue defines the struct that TLS protocol should return
+// from GetSecurityValue(), containing security info like cipher and certificate used.
+type TLSChannelzSecurityValue struct {
 	StandardName      string
 	LocalCertificate  []byte
 	RemoteCertificate []byte
 }
 
-func (*TLSSecurityValue) isSecurityValue() {}
+func (*TLSChannelzSecurityValue) isChannelzSecurityValue() {}
 
-// OtherSecurityValue defines the struct that non-TLS protocol should return from
-// GetSecurityValue(), which contains protocol specific security info.
-type OtherSecurityValue struct {
+// OtherChannelzSecurityValue defines the struct that non-TLS protocol should return
+// from GetSecurityValue(), which contains protocol specific security info. Note
+// the Value field will be sent to users of channelz requesting channel info, and
+// thus sensitive info should better be avoided.
+type OtherChannelzSecurityValue struct {
 	Name  string
 	Value proto.Message
 }
 
-func (*OtherSecurityValue) isSecurityValue() {}
+func (*OtherChannelzSecurityValue) isChannelzSecurityValue() {}

transport/http2_client.go

@@ -1254,7 +1254,7 @@ func (t *http2Client) ChannelzMetric() *channelz.SocketInternalMetric {
 		RemoteAddr:                      t.remoteAddr,
 		// RemoteName :
 	}
-	if au, ok := t.authInfo.(credentials.ExtraSecurityInfo); ok {
+	if au, ok := t.authInfo.(credentials.ChannelzSecurityInfo); ok {
 		s.Security = au.GetSecurityValue()
 	}
 	t.czmu.RUnlock()

transport/http2_server.go

@@ -1089,7 +1089,7 @@ func (t *http2Server) ChannelzMetric() *channelz.SocketInternalMetric {
 		RemoteAddr:                       t.remoteAddr,
 		// RemoteName :
 	}
-	if au, ok := t.authInfo.(credentials.ExtraSecurityInfo); ok {
+	if au, ok := t.authInfo.(credentials.ChannelzSecurityInfo); ok {
 		s.Security = au.GetSecurityValue()
 	}
 	t.czmu.RUnlock()