1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
package auth
import (
"context"
"fmt"
"strings"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
// contextKey is a custom type for context keys to avoid collisions.
type contextKey string
const (
// pubkeyContextKey is the key for storing the authenticated pubkey in context.
pubkeyContextKey contextKey = "nostr-pubkey"
)
// InterceptorOptions configures the authentication interceptor behavior.
type InterceptorOptions struct {
// TimestampWindow is the maximum age of auth events in seconds.
// Events older than this are rejected to prevent replay attacks.
// Default: 60 seconds
TimestampWindow int64
// Required determines whether authentication is mandatory.
// If true, requests without valid auth are rejected.
// If false, unauthenticated requests are allowed (pubkey will be empty).
// Default: false
Required bool
// ValidatePayload checks the payload hash tag if present.
// Default: false
ValidatePayload bool
// AllowedNpubsRead is an optional whitelist of allowed pubkeys for read operations (hex format).
// Config accepts npub format only, normalized to hex at load time.
// If nil or empty, all valid signatures are accepted for reads.
// Default: nil (allow all)
AllowedNpubsRead []string
// AllowedNpubsWrite is an optional whitelist of allowed pubkeys for write operations (hex format).
// Config accepts npub format only, normalized to hex at load time.
// If nil or empty, all valid signatures are accepted for writes.
// Default: nil (allow all)
AllowedNpubsWrite []string
// SkipMethods is a list of gRPC methods that bypass authentication.
// Useful for public endpoints like health checks or relay info.
// Example: []string{"/nostr.v1.NostrRelay/QueryEvents"}
// Default: nil (authenticate all methods)
SkipMethods []string
}
// DefaultInterceptorOptions returns the default configuration.
func DefaultInterceptorOptions() *InterceptorOptions {
return &InterceptorOptions{
TimestampWindow: 60,
Required: false,
ValidatePayload: false,
AllowedNpubsRead: nil,
AllowedNpubsWrite: nil,
SkipMethods: nil,
}
}
// NostrUnaryInterceptor creates a gRPC unary interceptor for NIP-98 authentication.
func NostrUnaryInterceptor(opts *InterceptorOptions) grpc.UnaryServerInterceptor {
if opts == nil {
opts = DefaultInterceptorOptions()
}
return func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
// Check if this method should skip auth
if shouldSkipAuth(info.FullMethod, opts.SkipMethods) {
return handler(ctx, req)
}
// Extract and validate auth
pubkey, err := validateAuthFromContext(ctx, info.FullMethod, opts)
if err != nil {
if opts.Required {
return nil, status.Error(codes.Unauthenticated, err.Error())
}
// Auth not required, continue without pubkey
return handler(ctx, req)
}
// Add pubkey to context for handlers
ctx = context.WithValue(ctx, pubkeyContextKey, pubkey)
return handler(ctx, req)
}
}
// NostrStreamInterceptor creates a gRPC stream interceptor for NIP-98 authentication.
func NostrStreamInterceptor(opts *InterceptorOptions) grpc.StreamServerInterceptor {
if opts == nil {
opts = DefaultInterceptorOptions()
}
return func(srv interface{}, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
// Check if this method should skip auth
if shouldSkipAuth(info.FullMethod, opts.SkipMethods) {
return handler(srv, ss)
}
// Extract and validate auth
ctx := ss.Context()
pubkey, err := validateAuthFromContext(ctx, info.FullMethod, opts)
if err != nil {
if opts.Required {
return status.Error(codes.Unauthenticated, err.Error())
}
// Auth not required, continue without pubkey
return handler(srv, ss)
}
// Wrap stream with authenticated context
wrappedStream := &authenticatedStream{
ServerStream: ss,
ctx: context.WithValue(ctx, pubkeyContextKey, pubkey),
}
return handler(srv, wrappedStream)
}
}
// authenticatedStream wraps a ServerStream with an authenticated context.
type authenticatedStream struct {
grpc.ServerStream
ctx context.Context
}
func (s *authenticatedStream) Context() context.Context {
return s.ctx
}
// validateAuthFromContext extracts and validates the NIP-98 auth event from the context.
func validateAuthFromContext(ctx context.Context, method string, opts *InterceptorOptions) (string, error) {
// Extract metadata from context
md, ok := metadata.FromIncomingContext(ctx)
if !ok {
return "", fmt.Errorf("missing metadata")
}
// Get authorization header
authHeaders := md.Get("authorization")
if len(authHeaders) == 0 {
return "", fmt.Errorf("missing authorization header")
}
authHeader := authHeaders[0]
// Parse the auth event
event, err := ParseAuthHeader(authHeader)
if err != nil {
return "", fmt.Errorf("invalid auth header: %w", err)
}
// Validate the event
validationOpts := ValidationOptions{
TimestampWindow: opts.TimestampWindow,
ValidatePayload: opts.ValidatePayload,
ExpectedMethod: "POST", // gRPC always uses POST
// Note: We don't validate URI here because the full URI isn't easily
// available in the interceptor context. The method name is validated instead.
}
if err := ValidateAuthEvent(event, validationOpts); err != nil {
return "", fmt.Errorf("invalid auth event: %w", err)
}
// Extract pubkey
pubkey := ExtractPubkey(event)
// Check whitelist based on operation type (all values are already normalized to hex)
if isWriteMethod(method) {
// Write operation - check write allowlist
if len(opts.AllowedNpubsWrite) > 0 {
if !contains(opts.AllowedNpubsWrite, pubkey) {
return "", fmt.Errorf("pubkey not authorized for write operations")
}
}
} else {
// Read operation - check read allowlist
if len(opts.AllowedNpubsRead) > 0 {
if !contains(opts.AllowedNpubsRead, pubkey) {
return "", fmt.Errorf("pubkey not authorized for read operations")
}
}
}
return pubkey, nil
}
// isWriteMethod determines if a gRPC method is a write operation.
// Write: PublishEvent, PublishBatch
// Read: Subscribe, Unsubscribe, QueryEvents, CountEvents
func isWriteMethod(method string) bool {
return strings.Contains(method, "/PublishEvent") || strings.Contains(method, "/PublishBatch")
}
// shouldSkipAuth checks if a method should bypass authentication.
func shouldSkipAuth(method string, skipMethods []string) bool {
for _, skip := range skipMethods {
if skip == method {
return true
}
}
return false
}
// contains checks if a slice contains a string.
func contains(slice []string, item string) bool {
for _, s := range slice {
if s == item {
return true
}
}
return false
}
// PubkeyFromContext retrieves the authenticated pubkey from the context.
// Returns the pubkey and true if authentication was successful, or empty string and false otherwise.
func PubkeyFromContext(ctx context.Context) (string, bool) {
pubkey, ok := ctx.Value(pubkeyContextKey).(string)
return pubkey, ok
}
// RequireAuth is a helper that extracts the pubkey and returns an error if not authenticated.
func RequireAuth(ctx context.Context) (string, error) {
pubkey, ok := PubkeyFromContext(ctx)
if !ok || pubkey == "" {
return "", status.Error(codes.Unauthenticated, "authentication required")
}
return pubkey, nil
}
|