package nauthz

Get desktop application:
View/edit binary Protocol Buffers messages

Authorization for actions against a relay

• rpc EventAdmit (EventRequest, EventReply)

  nauthz.proto:9

  Determine if an event should be admitted to the relay

  message EventRequest

  nauthz.proto:27

  Event data and metadata for authorization decisions

  • optional Event event = 1

    the event to be admitted for further relay processing

  • optional string ip_addr = 2

    IP address of the client that submitted the event

  • optional string origin = 3

    HTTP origin header from the client, if one exists

  • optional string user_agent = 4

    HTTP user-agent header from the client, if one exists

  • optional bytes auth_pubkey = 5

    the public key associated with a NIP-42 AUTH'd session, if

  • optional EventRequest.Nip05Name nip05 = 6

    authentication occurred

    NIP-05 address associated with the event pubkey, if it is

  message EventReply

  nauthz.proto:57

  Response to a event authorization request

  • Decision decision = 1

    decision to enforce

  • optional string message = 2

    informative message for the client

A permit or deny decision

Used in: EventReply

• DECISION_UNSPECIFIED = 0

• DECISION_PERMIT = 1

  Admit this event for further processing

• DECISION_DENY = 2

  Deny persisting or propagating this event

Used in: EventRequest

• bytes id = 1

  32-byte SHA256 hash of serialized event

• bytes pubkey = 2

  32-byte public key of event creator

• fixed64 created_at = 3

  UNIX timestamp provided by event creator

• uint64 kind = 4

  event kind

• string content = 5

  arbitrary event contents

• repeated Event.TagEntry tags = 6

  event tag array

• bytes sig = 7

  32-byte signature of the event id

Individual values for a single tag

Used in: Event

• repeated string values = 1

known and has been validated by the relay A NIP_05 verification record

Used in: EventRequest

• string local = 1

• string domain = 2