mirror of
https://github.com/fiatjaf/khatru.git
synced 2026-04-18 03:16:54 +02:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d0afc1f12 | ||
|
|
40c3dbdc76 | ||
|
|
e876415677 | ||
|
|
b00e5b2b3f | ||
|
|
0f7d26f26e | ||
|
|
21b08cb044 |
21
README.md
21
README.md
@@ -76,16 +76,17 @@ func main() {
|
|||||||
return false, "" // anyone else can
|
return false, "" // anyone else can
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
relay.OnConnect = append(relay.OnConnect,
|
|
||||||
func(ctx context.Context) {
|
// you can request auth by rejecting an event or a request with the prefix "auth-required: "
|
||||||
// request NIP-42 AUTH from everybody
|
relay.RejectFilter = append(relay.RejectFilter,
|
||||||
khatru.RequestAuth(ctx)
|
func(ctx context.Context, filter nostr.Filter) (reject bool, msg string) {
|
||||||
},
|
if pubkey := khatru.GetAuthed(ctx); pubkey != "" {
|
||||||
)
|
log.Printf("request from %s\n", pubkey)
|
||||||
relay.OnAuth = append(relay.OnAuth,
|
return false, ""
|
||||||
func(ctx context.Context, pubkey string) {
|
}
|
||||||
// and when they auth we just log that for nothing
|
return true, "auth-required: only authenticated users can read from this relay"
|
||||||
log.Println(pubkey + " is authed!")
|
// (this will cause an AUTH message to be sent and then a CLOSED message such that clients can
|
||||||
|
// authenticate and then request again)
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
// check the docs for more goodies!
|
// check the docs for more goodies!
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
"github.com/nbd-wtf/go-nostr"
|
"github.com/nbd-wtf/go-nostr"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// AddEvent sends an event through then normal add pipeline, as if it was received from a websocket.
|
||||||
func (rl *Relay) AddEvent(ctx context.Context, evt *nostr.Event) error {
|
func (rl *Relay) AddEvent(ctx context.Context, evt *nostr.Event) error {
|
||||||
if evt == nil {
|
if evt == nil {
|
||||||
return errors.New("error: event is nil")
|
return errors.New("error: event is nil")
|
||||||
@@ -82,46 +83,3 @@ func (rl *Relay) AddEvent(ctx context.Context, evt *nostr.Event) error {
|
|||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (rl *Relay) handleDeleteRequest(ctx context.Context, evt *nostr.Event) error {
|
|
||||||
// event deletion -- nip09
|
|
||||||
for _, tag := range evt.Tags {
|
|
||||||
if len(tag) >= 2 && tag[0] == "e" {
|
|
||||||
// first we fetch the event
|
|
||||||
for _, query := range rl.QueryEvents {
|
|
||||||
ch, err := query(ctx, nostr.Filter{IDs: []string{tag[1]}})
|
|
||||||
if err != nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
target := <-ch
|
|
||||||
if target == nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
// got the event, now check if the user can delete it
|
|
||||||
acceptDeletion := target.PubKey == evt.PubKey
|
|
||||||
var msg string
|
|
||||||
if acceptDeletion == false {
|
|
||||||
msg = "you are not the author of this event"
|
|
||||||
}
|
|
||||||
// but if we have a function to overwrite this outcome, use that instead
|
|
||||||
for _, odo := range rl.OverwriteDeletionOutcome {
|
|
||||||
acceptDeletion, msg = odo(ctx, target, evt)
|
|
||||||
}
|
|
||||||
if acceptDeletion {
|
|
||||||
// delete it
|
|
||||||
for _, del := range rl.DeleteEvent {
|
|
||||||
del(ctx, target)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// fail and stop here
|
|
||||||
return fmt.Errorf("blocked: %s", msg)
|
|
||||||
}
|
|
||||||
|
|
||||||
// don't try to query this same event again
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
11
broadcasting.go
Normal file
11
broadcasting.go
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
package khatru
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/nbd-wtf/go-nostr"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BroadcastEvent emits an event to all listeners whose filters' match, skipping all filters and actions
|
||||||
|
// it also doesn't attempt to store the event or trigger any reactions or callbacks
|
||||||
|
func (rl *Relay) BroadcastEvent(evt *nostr.Event) {
|
||||||
|
notifyListeners(evt)
|
||||||
|
}
|
||||||
51
deleting.go
Normal file
51
deleting.go
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
package khatru
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/nbd-wtf/go-nostr"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (rl *Relay) handleDeleteRequest(ctx context.Context, evt *nostr.Event) error {
|
||||||
|
// event deletion -- nip09
|
||||||
|
for _, tag := range evt.Tags {
|
||||||
|
if len(tag) >= 2 && tag[0] == "e" {
|
||||||
|
// first we fetch the event
|
||||||
|
for _, query := range rl.QueryEvents {
|
||||||
|
ch, err := query(ctx, nostr.Filter{IDs: []string{tag[1]}})
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
target := <-ch
|
||||||
|
if target == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// got the event, now check if the user can delete it
|
||||||
|
acceptDeletion := target.PubKey == evt.PubKey
|
||||||
|
var msg string
|
||||||
|
if acceptDeletion == false {
|
||||||
|
msg = "you are not the author of this event"
|
||||||
|
}
|
||||||
|
// but if we have a function to overwrite this outcome, use that instead
|
||||||
|
for _, odo := range rl.OverwriteDeletionOutcome {
|
||||||
|
acceptDeletion, msg = odo(ctx, target, evt)
|
||||||
|
}
|
||||||
|
if acceptDeletion {
|
||||||
|
// delete it
|
||||||
|
for _, del := range rl.DeleteEvent {
|
||||||
|
del(ctx, target)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// fail and stop here
|
||||||
|
return fmt.Errorf("blocked: %s", msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// don't try to query this same event again
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -69,12 +69,8 @@ func main() {
|
|||||||
return false, ""
|
return false, ""
|
||||||
}
|
}
|
||||||
return true, "auth-required: only authenticated users can read from this relay"
|
return true, "auth-required: only authenticated users can read from this relay"
|
||||||
},
|
// (this will cause an AUTH message to be sent and then a CLOSED message such that clients can
|
||||||
)
|
// authenticate and then request again)
|
||||||
relay.OnAuth = append(relay.OnAuth,
|
|
||||||
func(ctx context.Context, pubkey string) {
|
|
||||||
// and when they auth we can just log that for nothing
|
|
||||||
log.Println(pubkey + " is authed!")
|
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
// check the docs for more goodies!
|
// check the docs for more goodies!
|
||||||
|
|||||||
@@ -50,7 +50,6 @@ func (rl *Relay) HandleWebsocket(w http.ResponseWriter, r *http.Request) {
|
|||||||
conn: conn,
|
conn: conn,
|
||||||
Request: r,
|
Request: r,
|
||||||
Challenge: hex.EncodeToString(challenge),
|
Challenge: hex.EncodeToString(challenge),
|
||||||
Authed: make(chan struct{}),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(
|
ctx, cancel := context.WithCancel(
|
||||||
@@ -204,7 +203,12 @@ func (rl *Relay) HandleWebsocket(w http.ResponseWriter, r *http.Request) {
|
|||||||
wsBaseUrl := strings.Replace(rl.ServiceURL, "http", "ws", 1)
|
wsBaseUrl := strings.Replace(rl.ServiceURL, "http", "ws", 1)
|
||||||
if pubkey, ok := nip42.ValidateAuthEvent(&env.Event, ws.Challenge, wsBaseUrl); ok {
|
if pubkey, ok := nip42.ValidateAuthEvent(&env.Event, ws.Challenge, wsBaseUrl); ok {
|
||||||
ws.AuthedPublicKey = pubkey
|
ws.AuthedPublicKey = pubkey
|
||||||
close(ws.Authed)
|
ws.authLock.Lock()
|
||||||
|
if ws.Authed != nil {
|
||||||
|
close(ws.Authed)
|
||||||
|
ws.Authed = nil
|
||||||
|
}
|
||||||
|
ws.authLock.Unlock()
|
||||||
ws.WriteJSON(nostr.OKEnvelope{EventID: env.Event.ID, OK: true})
|
ws.WriteJSON(nostr.OKEnvelope{EventID: env.Event.ID, OK: true})
|
||||||
} else {
|
} else {
|
||||||
ws.WriteJSON(nostr.OKEnvelope{EventID: env.Event.ID, OK: false, Reason: "error: failed to authenticate"})
|
ws.WriteJSON(nostr.OKEnvelope{EventID: env.Event.ID, OK: false, Reason: "error: failed to authenticate"})
|
||||||
|
|||||||
1
relay.go
1
relay.go
@@ -54,7 +54,6 @@ type Relay struct {
|
|||||||
DeleteEvent []func(ctx context.Context, event *nostr.Event) error
|
DeleteEvent []func(ctx context.Context, event *nostr.Event) error
|
||||||
QueryEvents []func(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)
|
QueryEvents []func(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)
|
||||||
CountEvents []func(ctx context.Context, filter nostr.Filter) (int64, error)
|
CountEvents []func(ctx context.Context, filter nostr.Filter) (int64, error)
|
||||||
OnAuth []func(ctx context.Context, pubkey string)
|
|
||||||
OnConnect []func(ctx context.Context)
|
OnConnect []func(ctx context.Context)
|
||||||
OnDisconnect []func(ctx context.Context)
|
OnDisconnect []func(ctx context.Context)
|
||||||
OnEventSaved []func(ctx context.Context, event *nostr.Event)
|
OnEventSaved []func(ctx context.Context, event *nostr.Event)
|
||||||
|
|||||||
@@ -18,7 +18,9 @@ func (rl *Relay) handleRequest(ctx context.Context, id string, eose *sync.WaitGr
|
|||||||
}
|
}
|
||||||
|
|
||||||
if filter.Limit < 0 {
|
if filter.Limit < 0 {
|
||||||
return errors.New("blocked: filter invalidated")
|
// this is a special situation through which the implementor signals to us that it doesn't want
|
||||||
|
// to event perform any queries whatsoever
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// then check if we'll reject this filter (we apply this after overwriting
|
// then check if we'll reject this filter (we apply this after overwriting
|
||||||
5
utils.go
5
utils.go
@@ -14,6 +14,11 @@ const (
|
|||||||
|
|
||||||
func RequestAuth(ctx context.Context) {
|
func RequestAuth(ctx context.Context) {
|
||||||
ws := GetConnection(ctx)
|
ws := GetConnection(ctx)
|
||||||
|
ws.authLock.Lock()
|
||||||
|
if ws.Authed == nil {
|
||||||
|
ws.Authed = make(chan struct{})
|
||||||
|
}
|
||||||
|
ws.authLock.Unlock()
|
||||||
ws.WriteJSON(nostr.AuthEnvelope{Challenge: &ws.Challenge})
|
ws.WriteJSON(nostr.AuthEnvelope{Challenge: &ws.Challenge})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,8 @@ type WebSocket struct {
|
|||||||
Challenge string
|
Challenge string
|
||||||
AuthedPublicKey string
|
AuthedPublicKey string
|
||||||
Authed chan struct{}
|
Authed chan struct{}
|
||||||
|
|
||||||
|
authLock sync.Mutex
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ws *WebSocket) WriteJSON(any any) error {
|
func (ws *WebSocket) WriteJSON(any any) error {
|
||||||
|
|||||||
Reference in New Issue
Block a user