web

Documentation

Overview

Package web implements nostr websockets with their authentication state.

Index

• type Socket
  • func NewSocket(conn *websocket.Conn, req *http.Request, challenge []byte) (ws *Socket)
  • func (ws *Socket) AuthRequested() bool
  • func (ws *Socket) Authed() string
  • func (ws *Socket) AuthedBytes() []byte
  • func (ws *Socket) Challenge() string
  • func (ws *Socket) Close() (err error)
  • func (ws *Socket) IsAuthed() bool
  • func (ws *Socket) RealRemote() string
  • func (ws *Socket) Req() *http.Request
  • func (ws *Socket) RequestAuth()
  • func (ws *Socket) SetAuthed(s string)
  • func (ws *Socket) Write(p []byte) (n int, err error)
  • func (ws *Socket) WriteJSON(any interface{}) error
  • func (ws *Socket) WriteMessage(t int, b []byte) error

Types

type Socket

type Socket struct {
	// contains filtered or unexported fields
}

func NewSocket

func NewSocket(
	conn *websocket.Conn,
	req *http.Request,
	challenge []byte,
) (ws *Socket)

func (*Socket) AuthRequested

func (ws *Socket) AuthRequested() bool

func (*Socket) Authed

func (ws *Socket) Authed() string

func (*Socket) AuthedBytes

func (ws *Socket) AuthedBytes() []byte

func (*Socket) Challenge

func (ws *Socket) Challenge() string

func (*Socket) Close

func (ws *Socket) Close() (err error)

func (*Socket) IsAuthed

func (ws *Socket) IsAuthed() bool

func (*Socket) RealRemote

func (ws *Socket) RealRemote() string

func (*Socket) Req

func (ws *Socket) Req() *http.Request

func (*Socket) RequestAuth

func (ws *Socket) RequestAuth()

func (*Socket) SetAuthed

func (ws *Socket) SetAuthed(s string)

func (*Socket) Write

func (ws *Socket) Write(p []byte) (n int, err error)

func (*Socket) WriteJSON

func (ws *Socket) WriteJSON(any interface{}) error

func (*Socket) WriteMessage

func (ws *Socket) WriteMessage(t int, b []byte) error