mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-09 22:09:06 -05:00
drastically simplify @semisol's auth NIP.
This commit is contained in:
parent
b9467cb428
commit
c80be21cd4
71
41.md
71
41.md
|
@ -1,71 +0,0 @@
|
|||
NIP-41
|
||||
======
|
||||
|
||||
Authentication of clients to relays
|
||||
-----------------------------------
|
||||
|
||||
`draft` `optional` `author:Semisol`
|
||||
|
||||
This NIP defines a way for clients to authenticate to relays by signing an ephemeral event.
|
||||
|
||||
## Event format
|
||||
|
||||
An event should be signed with `kind: 22241` and `content` being the WebSockets URL of the relay.
|
||||
The URL MUST:
|
||||
- Have a trailing slash if the path is `/`
|
||||
- Not have a port number if protocol is `ws` and port is `80` or protocol is `wss` and port is `443`
|
||||
- Not include the search/query
|
||||
|
||||
Relays SHOULD treat authenticaiton events with a valid delegation as if it was the delegator authenticating.
|
||||
|
||||
An example event is shown below:
|
||||
```json
|
||||
{
|
||||
"id": "...",
|
||||
"pubkey": "...",
|
||||
"created_at": 1669695536,
|
||||
"kind": 22241,
|
||||
"tags": [],
|
||||
"content": "wss://relay.example.com/",
|
||||
"sig": "..."
|
||||
}
|
||||
```
|
||||
|
||||
## Commands between the relay and the client
|
||||
|
||||
This NIP defines a new command, `AUTH`, which can be sent by either the relay or the client with different meanings.
|
||||
|
||||
A relay may send `["AUTH", <human readable reason>, <data object>]` when it needs authentication (examples: accessing kind 4 events, whitelist only, requiring proof of authorship for `EVENT`).
|
||||
The human readable reason SHOULD be prefixed with a string in the format `<short desc string>: <description>`. A list of short descriptions is listed below:
|
||||
- `restricted`: This relay is restricted and requires the pubkey of the client to check if it can access the relay. (requires a whitelist, payment, etc)
|
||||
- `publish`: The relay requests that the client identify who is sending an `EVENT` command.
|
||||
This can be used for where only the signer of an event can publish it, or a pay-as-you-go relay allowing for you to publish others' events
|
||||
- `private`: The client has attempted to access a restricted set of events (example: kind 4 DMs) and should authenticate with the relay to receive them.
|
||||
- `other`: Any reason not defined here.
|
||||
|
||||
`data object` MUST be a JSON object. It currently has one defined field, but may be extended by amendments to this NIP or other NIPs:
|
||||
- `subscription_id`: The subscription ID that triggered the `AUTH` request.
|
||||
|
||||
A client may send one of the following to the relay:
|
||||
- `["AUTH", <signed event>]` to indicate it has accepted the request. This may also be sent without an authentication request.
|
||||
- `["AUTH", null]` to indicate it has rejected the request.
|
||||
|
||||
A relay SHOULD send the [`OK`](https://github.com/nostr-protocol/nips/blob/master/20.md) command after they receive a
|
||||
non-rejecting authentication response, and use one of the following `message` prefixes if the event sent cannot be verified:
|
||||
- `too-old:`: The event signed has a too old `created_at` date.
|
||||
- `invalid-url:`: The URL in `content` is not matching.
|
||||
- `already-used:`: This event was already used to authenticate to this relay.
|
||||
- `bad-signature:`: The event has a bad signature.
|
||||
|
||||
Please note that the `OK` message should only be sent as a response to other commands that the client sends instead of the `AUTH` command if the issue is not related to the authentication event being incorrectly signed (example: not on whitelist).
|
||||
|
||||
Relays SHOULD send [`EOSE`](https://github.com/nostr-protocol/nips/blob/master/15.md) when an authentication request is triggered by a `REQ` command, and not send stored events after the `EOSE` when authentication is completed.
|
||||
Relays SHOULD send `OK` as a response when a command triggers authentication with the reason starting with `auth:`.
|
||||
|
||||
Clients SHOULD retry the action (resending event, resubscribing) after they authenticate if they receive an `AUTH` request.
|
||||
|
||||
## Signed event verification
|
||||
Relays when processing `AUTH` responses SHOULD verify the following before accepting the response:
|
||||
- that the `kind` is `22241`
|
||||
- that the event was recently signed (~10 minutes, by `created_at`)
|
||||
- that the `content` field matches the relay URL
|
68
42.md
Normal file
68
42.md
Normal file
|
@ -0,0 +1,68 @@
|
|||
NIP-42
|
||||
======
|
||||
|
||||
Authentication of clients to relays
|
||||
-----------------------------------
|
||||
|
||||
`draft` `optional` `author:Semisol` `author:fiatjaf`
|
||||
|
||||
This NIP defines a way for clients to authenticate to relays by signing an ephemeral event.
|
||||
|
||||
## Motivation
|
||||
|
||||
A relay may want to require clients to authenticate to access restricted resources. For example,
|
||||
|
||||
- A relay may request payment or other forms of whitelisting to publish events -- this can naïvely be achieved by limiting publication
|
||||
to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an
|
||||
authenticated user;
|
||||
- A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication
|
||||
before clients can query for that kind.
|
||||
- A relay may limit subscriptions of any kind to paying users or users whitelisted through any other means, and require authentication.
|
||||
|
||||
## Protocol flow
|
||||
|
||||
This NIP defines a new message, `AUTH`, which clients can send to relays when they want to authenticate. The message is of the following form:
|
||||
|
||||
```
|
||||
["AUTH", <signed-event>]
|
||||
```
|
||||
|
||||
The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and content must be set to the
|
||||
WebSocket URL of the relay. `created_at` should be the current time. Example:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "...",
|
||||
"pubkey": "...",
|
||||
"created_at": 1669695536,
|
||||
"kind": 22242,
|
||||
"tags": [],
|
||||
"content": "wss://relay.example.com/",
|
||||
"sig": "..."
|
||||
}
|
||||
```
|
||||
|
||||
The client may send an auth message right before performing an action for which it knows authentication will be required -- for example, right
|
||||
before requesting `kind: 4` chat messages --, or it may do right on connection start or at some other moment it deems best.
|
||||
|
||||
Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For
|
||||
that it can use a `NOTICE` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example:
|
||||
|
||||
```
|
||||
["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"]
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
["NOTICE", "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"]
|
||||
```
|
||||
|
||||
## Signed Event Verification
|
||||
|
||||
To verify `AUTH` messages, relays must ensure:
|
||||
|
||||
- that the `kind` is `22242`
|
||||
- that the event was recently signed (~10 minutes, by `created_at`)
|
||||
- that the `content` field matches the relay URL
|
||||
- URL normalization techniques can be applied. For most cases just checking if the domain name is correct should be enough.
|
13
README.md
13
README.md
|
@ -28,6 +28,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh
|
|||
- [NIP-35: User Discovery](35.md)
|
||||
- [NIP-36: Sensitive Content](36.md)
|
||||
- [NIP-40: Expiration Timestamp](40.md)
|
||||
- [NIP-42: Authentication of clients to relays](42.md)
|
||||
|
||||
## Event Kinds
|
||||
|
||||
|
@ -47,6 +48,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh
|
|||
| 43 | Channel Hide Message | [28](28.md) |
|
||||
| 44 | Channel Mute User | [28](28.md) |
|
||||
| 45-49 | Public Chat Reserved | [28](28.md) |
|
||||
| 22242 | Client Authentication | [42](42.md) |
|
||||
| 10000-19999 | Replaceable Events Reserved | [16](16.md) |
|
||||
| 20000-29999 | Ephemeral Events Reserved | [16](16.md) |
|
||||
|
||||
|
@ -54,11 +56,12 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh
|
|||
## Message types
|
||||
|
||||
### Client to Relay
|
||||
| type | description | NIP |
|
||||
|-------|-----------------------------------------------------|------------|
|
||||
| EVENT | used to publish events | [1](01.md) |
|
||||
| REQ | used to request events and subscribe to new updates | [1](01.md) |
|
||||
| CLOSE | used to stop previous subscriptions | [1](01.md) |
|
||||
| type | description | NIP |
|
||||
|-------|-----------------------------------------------------|-------------|
|
||||
| EVENT | used to publish events | [1](01.md) |
|
||||
| REQ | used to request events and subscribe to new updates | [1](01.md) |
|
||||
| CLOSE | used to stop previous subscriptions | [1](01.md) |
|
||||
| AUTH | used to send authentication events | [42](42.md) |
|
||||
|
||||
### Relay to Client
|
||||
| type | description | NIP |
|
||||
|
|
Loading…
Reference in New Issue
Block a user