Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log incoming metadata of JWT verified nodes #402

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+57 −22
Draft

Log incoming metadata of JWT verified nodes #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d44fb5
Log incoming metadata of JWT verified nodes
mkysel Jan 9, 2025
1241572
not meant to commit
mkysel Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pkg/authn/claims_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func TestClaimsVerifierNoVersion(t *testing.T) {

token, err := tokenFactory.CreateToken(uint32(VERIFIER_NODE_ID))
require.NoError(t, err)
verificationError := verifier.Verify(token.SignedString)
_, verificationError := verifier.Verify(token.SignedString)
if tt.wantErr {
require.Error(t, verificationError)
} else {
Expand Down Expand Up @@ -119,7 +119,7 @@ func TestClaimsVerifier(t *testing.T) {

token, err := tokenFactory.CreateToken(uint32(VERIFIER_NODE_ID))
require.NoError(t, err)
verificationError := verifier.Verify(token.SignedString)
_, verificationError := verifier.Verify(token.SignedString)
if tt.wantErr {
require.Error(t, verificationError)
} else {
Expand Down
2 changes: 1 addition & 1 deletion pkg/authn/interface.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package authn

type JWTVerifier interface {
Verify(tokenString string) error
Verify(tokenString string) (uint32, error)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Update mock implementation to handle both return values

The interface change is properly implemented in the main code, but the mock implementation needs to be updated. The mock's Return and RunAndReturn methods are incorrectly handling the return values:

  • pkg/mocks/authn/mock_JWTVerifier.go: Update Return and RunAndReturn to handle both uint32 and error return values.
🔗 Analysis chain

Verify all implementations of the JWTVerifier interface

The change to return (uint32, error) instead of just error is a breaking change that requires updates to all implementations of the JWTVerifier interface.

Let's verify all implementations:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find all implementations of JWTVerifier interface
ast-grep --pattern 'type $_ struct {
  $$$
}

func ($_ *$_) Verify(tokenString string) (uint32, error) {
  $$$
}'

Length of output: 115

Script:

#!/bin/bash
# Try different approaches to find implementations

# Search for any Verify method with the new signature
echo "=== Searching for Verify method implementations ==="
ast-grep --pattern 'func $_($_ $_) Verify(tokenString string) (uint32, error)'

# Use ripgrep to find potential implementation files
echo -e "\n=== Searching for files mentioning JWTVerifier ==="
rg -l "JWTVerifier"

# Search for Verify method calls to find potential implementations
echo -e "\n=== Searching for Verify method calls ==="
rg "\.Verify\("

Length of output: 2274

Script:

#!/bin/bash
# Find the verifier implementation
echo "=== Searching for verifier implementation ==="
fd "verifier\.go" --exclude "*test.go" --exclude "*mock*.go"

# Check mock implementation
echo -e "\n=== Checking mock implementation ==="
cat pkg/mocks/authn/mock_JWTVerifier.go

# Search for struct definitions in verifier files
echo -e "\n=== Searching for verifier structs ==="
rg -A 5 "type.*struct" pkg/authn/

Length of output: 4015

Script:

#!/bin/bash
# Check the verifier implementation
echo "=== Checking verifier implementation ==="
cat pkg/authn/verifier.go

# Also check auth.go since it's using the Verify method
echo -e "\n=== Checking auth interceptor usage ==="
cat pkg/interceptors/server/auth.go

Length of output: 7757

}
12 changes: 6 additions & 6 deletions pkg/authn/verifier.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func NewRegistryVerifier(registry registry.NodeRegistry, myNodeID uint32) *Regis
return &RegistryVerifier{registry: registry, myNodeID: myNodeID}
}

func (v *RegistryVerifier) Verify(tokenString string) error {
func (v *RegistryVerifier) Verify(tokenString string) (uint32, error) {
var token *jwt.Token
var err error

Expand All @@ -36,21 +36,21 @@ func (v *RegistryVerifier) Verify(tokenString string) error {
&XmtpdClaims{},
v.getMatchingPublicKey,
); err != nil {
return err
return 0, err
}
if err = v.validateAudience(token); err != nil {
return err
return 0, err
}

if err = validateExpiry(token); err != nil {
return err
return 0, err
}

if err = v.validateClaims(token); err != nil {
return err
return 0, err
}

return nil
return getSubjectNodeId(token)
}

func (v *RegistryVerifier) getMatchingPublicKey(token *jwt.Token) (interface{}, error) {
Expand Down
18 changes: 9 additions & 9 deletions pkg/authn/verifier_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@ func TestVerifier(t *testing.T) {
token, err := tokenFactory.CreateToken(uint32(VERIFIER_NODE_ID))
require.NoError(t, err)
// This should verify correctly
verificationError := verifier.Verify(token.SignedString)
_, verificationError := verifier.Verify(token.SignedString)
require.NoError(t, verificationError)

// Create a token targeting a different node as the audience
tokenForWrongNode, err := tokenFactory.CreateToken(uint32(300))
require.NoError(t, err)
// This should not verify correctly
verificationError = verifier.Verify(tokenForWrongNode.SignedString)
_, verificationError = verifier.Verify(tokenForWrongNode.SignedString)
require.Error(t, verificationError)
}

Expand All @@ -90,7 +90,7 @@ func TestWrongAudience(t *testing.T) {
tokenForWrongNode, err := tokenFactory.CreateToken(uint32(300))
require.NoError(t, err)
// This should not verify correctly
verificationError := verifier.Verify(tokenForWrongNode.SignedString)
_, verificationError := verifier.Verify(tokenForWrongNode.SignedString)
require.Error(t, verificationError)
}

Expand All @@ -105,7 +105,7 @@ func TestUnknownNode(t *testing.T) {
token, err := tokenFactory.CreateToken(uint32(VERIFIER_NODE_ID))
require.NoError(t, err)

verificationError := verifier.Verify(token.SignedString)
_, verificationError := verifier.Verify(token.SignedString)
require.Error(t, verificationError)
}

Expand All @@ -125,7 +125,7 @@ func TestWrongPublicKey(t *testing.T) {
token, err := tokenFactory.CreateToken(uint32(VERIFIER_NODE_ID))
require.NoError(t, err)

verificationError := verifier.Verify(token.SignedString)
_, verificationError := verifier.Verify(token.SignedString)
require.Error(t, verificationError)
}

Expand All @@ -147,7 +147,7 @@ func TestExpiredToken(t *testing.T) {
time.Now().Add(-time.Hour),
)

verificationError := verifier.Verify(signedString)
_, verificationError := verifier.Verify(signedString)
require.Error(t, verificationError)
}

Expand All @@ -169,7 +169,7 @@ func TestTokenDurationTooLong(t *testing.T) {
time.Now().Add(5*time.Hour),
)

verificationError := verifier.Verify(signedString)
_, verificationError := verifier.Verify(signedString)
require.Error(t, verificationError)
}

Expand All @@ -192,7 +192,7 @@ func TestTokenClockSkew(t *testing.T) {
time.Now().Add(1*time.Hour),
)

verificationError := verifier.Verify(validToken)
_, verificationError := verifier.Verify(validToken)
require.NoError(t, verificationError)

invalidToken := buildJwt(
Expand All @@ -204,6 +204,6 @@ func TestTokenClockSkew(t *testing.T) {
time.Now().Add(1*time.Hour),
)

verificationError = verifier.Verify(invalidToken)
_, verificationError = verifier.Verify(invalidToken)
require.Error(t, verificationError)
}
39 changes: 37 additions & 2 deletions pkg/interceptors/server/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package server

import (
"context"
"google.golang.org/grpc/peer"
"net"

"github.com/xmtp/xmtpd/pkg/authn"
"github.com/xmtp/xmtpd/pkg/constants"
Expand Down Expand Up @@ -54,6 +56,31 @@ func extractToken(ctx context.Context) (string, error) {
return values[0], nil
}

func (i *AuthInterceptor) logIncomingAddressIfAvailable(ctx context.Context, nodeId uint32) {
if i.logger.Core().Enabled(zap.DebugLevel) {
if p, ok := peer.FromContext(ctx); ok {
clientAddr := p.Addr.String()
var dnsName []string
// Attempt to resolve the DNS name
host, _, err := net.SplitHostPort(clientAddr)
if err == nil {
dnsName, err = net.LookupAddr(host)
if err != nil || len(dnsName) == 0 {
dnsName = []string{"Unknown"}
}
} else {
dnsName = []string{"Unknown"}
}
i.logger.Debug(
"Incoming connection",
zap.String("client_addr", clientAddr),
zap.String("dns_name", dnsName[0]),
zap.Uint32("node_id", nodeId),
)
}
}
}

// Unary returns a grpc.UnaryServerInterceptor that validates JWT tokens
func (i *AuthInterceptor) Unary() grpc.UnaryServerInterceptor {
return func(
Expand All @@ -68,13 +95,17 @@ func (i *AuthInterceptor) Unary() grpc.UnaryServerInterceptor {
return handler(ctx, req)
}

if err := i.verifier.Verify(token); err != nil {
nodeId, err := i.verifier.Verify(token)
if err != nil {
return nil, status.Errorf(
codes.Unauthenticated,
"invalid auth token: %v",
err,
)
}

i.logIncomingAddressIfAvailable(ctx, nodeId)

ctx = context.WithValue(ctx, constants.VerifiedNodeRequestCtxKey{}, true)

return handler(ctx, req)
Expand All @@ -95,14 +126,18 @@ func (i *AuthInterceptor) Stream() grpc.StreamServerInterceptor {
return handler(srv, stream)
}

if err := i.verifier.Verify(token); err != nil {
nodeId, err := i.verifier.Verify(token)

if err != nil {
return status.Errorf(
codes.Unauthenticated,
"invalid auth token: %v",
err,
)
}

i.logIncomingAddressIfAvailable(stream.Context(), nodeId)

stream = &wrappedServerStream{
ServerStream: stream,
ctx: context.WithValue(
Expand Down
4 changes: 2 additions & 2 deletions pkg/mocks/authn/mock_JWTVerifier.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading