Merge branch 'master' into draft-event

1 files changed, 115 insertions, 115 deletions

diff --git a/46.md b/46.md
index 1528116..d170628 100644
--- a/46.md
+++ b/46.md
@@ -1,4 +1,12 @@
-# NIP-46 - Nostr Remote Signing
+NIP-46
+======
+
+Nostr Remote Signing
+--------------------
+
+## Changes
+
+`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect, nip05 login is removed, create_account moved to another NIP.
 
 ## Rationale
 
@@ -8,102 +16,70 @@ This NIP describes a method for 2-way communication between a remote signer and
 
 ## Terminology
 
-- **Local keypair**: A local public and private key-pair used to encrypt content and communicate with the remote signer. Usually created by the client application.
-- **Remote user pubkey**: The public key that the user wants to sign as. The remote signer has control of the private key that matches this public key.
-- **Remote signer pubkey**: This is the public key of the remote signer itself. This is needed in both `create_account` command because you don't yet have a remote user pubkey.
+- **user**: A person that is trying to use Nostr.
+- **client**: A user-facing application that _user_ is looking at and clicking buttons in. This application will send requests to _remote-signer_.
+- **remote-signer**: A daemon or server running somewhere that will answer requests from _client_, also known as "bunker".
+- **client-keypair/pubkey**: The keys generated by _client_. Used to encrypt content and communicate with _remote-signer_.
+- **remote-signer-keypair/pubkey**: The keys used by _remote-signer_ to encrypt content and communicate with _client_. This keypair MAY be same as _user-keypair_, but not necessarily.
+- **user-keypair/pubkey**: The actual keys representing _user_ (that will be used to sign events in response to `sign_event` requests, for example). The _remote-signer_ generally has control over these keys.
 
 All pubkeys specified in this NIP are in hex format.
 
-## Initiating a connection
-
-To initiate a connection between a client and a remote signer there are a few different options.
-
-### Direct connection initiated by remote signer
+## Overview
 
-This is most common in a situation where you have your own nsecbunker or other type of remote signer and want to connect through a client that supports remote signing.
+1. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout;
+2. A connection is established (see below), _remote-signer_ learns `client-pubkey`, _client_ learns `remote-signer-pubkey`.
+3. _client_ uses `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`;
+4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`.
+5. _client_ requests `get_public_key` to learn `user-pubkey`.
 
-The remote signer would provide a connection token in the form:
-
-```
-bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
-```
+## Initiating a connection
 
-This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s).
+There are two ways to initiate a connection:
 
-### Direct connection initiated by the client
+### Direct connection initiated by _remote-signer_
 
-In this case, basically the opposite direction of the first case, the client provides a connection token (or encodes the token in a QR code) and the signer initiates a connection to the client via the specified relay(s).
+_remote-signer_ provides connection token in the form:
 
 ```
-nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}>
+bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
 ```
 
-## The flow
+_user_ passes this token to _client_, which then sends `connect` request to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old secret.
 
-1. Client creates a local keypair. This keypair doesn't need to be communicated to the user since it's largely disposable (i.e. the user doesn't need to see this pubkey). Clients might choose to store it locally and they should delete it when the user logs out.
-2. Client gets the remote user pubkey (either via a `bunker://` connection string or a NIP-05 login-flow; shown below)
-3. Clients use the local keypair to send requests to the remote signer by `p`-tagging and encrypting to the remote user pubkey.
-4. The remote signer responds to the client by `p`-tagging and encrypting to the local keypair pubkey.
+### Direct connection initiated by the _client_
 
-### Example flow for signing an event
+_client_ provides a connection token using `nostrconnect://` as the protocol, and `client-pubkey` as the origin. Additional information should be passed as query parameters:
 
-- Remote user pubkey (e.g. signing as) `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
-- Local pubkey is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86`
+- `relay` (required) - one or more relay urls on which the _client_ is listening for responses from the _remote-signer_.
+- `secret` (required) - a short random string that the _remote-signer_ should return as the `result` field of its response.
+- `perms` (optional) - a comma-separated list of permissions the _client_ is requesting be approved by the _remote-signer_
+- `name` (optional) - the name of the _client_ application
+- `url` (optional) - the canonical url of the _client_ application
+- `image` (optional) - a small image representing the _client_ application
 
-#### Signature request
+Here's an example:
 
-```json
-{
-    "kind": 24133,
-    "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
-    "content": nip04({
-        "id": <random_string>,
-        "method": "sign_event",
-        "params": [json_stringified(<{
-            content: "Hello, I'm signing remotely",
-            kind: 1,
-            tags: [],
-            created_at: 1714078911
-        }>)]
-    }),
-    "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey
-}
 ```
-
-#### Response event
-
-```json
-{
-    "kind": 24133,
-    "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
-    "content": nip04({
-        "id": <random_string>,
-        "result": json_stringified(<signed-event>)
-    }),
-    "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the local keypair pubkey
-}
+nostrconnect://83f3b2ae6aa368e8275397b9c26cf550101d63ebaab900d19dd4a4429f5ad8f5?relay=wss%3A%2F%2Frelay1.example.com&perms=nip44_encrypt%2Cnip44_decrypt%2Csign_event%3A13%2Csign_event%3A14%2Csign_event%3A1059&name=My+Client&secret=0s8j2djs&relay=wss%3A%2F%2Frelay2.example2.com
 ```
 
-#### Diagram
-
-![signing-example](https://i.nostr.build/P3gW.png)
+_user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response.
 
 ## Request Events `kind: 24133`
 
-```json
+```jsonc
 {
-    "id": <id>,
     "kind": 24133,
     "pubkey": <local_keypair_pubkey>,
-    "content": <nip04(<request>)>,
-    "tags": [["p", <remote_user_pubkey>]], // NB: in the `create_account` event, the remote signer pubkey should be `p` tagged.
-    "created_at": <unix timestamp in seconds>
+    "content": <nip44(<request>)>,
+    "tags": [["p", <remote-signer-pubkey>]],
 }
 ```
 
-The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure:
+The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure:
 
-```json
+```jsonc
 {
     "id": <random_string>,
     "method": <method_name>,
@@ -117,15 +93,15 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.c
 
 ### Methods/Commands
 
-Each of the following are methods that the client sends to the remote signer.
+Each of the following are methods that the _client_ sends to the _remote-signer_.
 
 | Command                  | Params                                                                        | Result                                                                 |
 | ------------------------ | -------------------------------------------------                             | ---------------------------------------------------------------------- |
-| `connect`                | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack"                                                                  |
+| `connect`                | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_permissions>]`        | "ack" OR `<required-secret-value>`                                                                  |
 | `sign_event`             | `[<{kind, content, tags, created_at}>]`                                       | `json_stringified(<signed_event>)`                                     |
 | `ping`                   | `[]`                                                                          | "pong"                                                                 |
 | `get_relays`             | `[]`                                                                          | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` |
-| `get_public_key`         | `[]`                                                                          | `<hex-pubkey>`                                                         |
+| `get_public_key`         | `[]`                                                                          | `<user-pubkey>`                                                         |
 | `nip04_encrypt`          | `[<third_party_pubkey>, <plaintext_to_encrypt>]`                              | `<nip04_ciphertext>`                                                   |
 | `nip04_decrypt`          | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]`                       | `<plaintext>`                                                          |
 | `nip44_encrypt`          | `[<third_party_pubkey>, <plaintext_to_encrypt>]`                              | `<nip44_ciphertext>`                                                   |
@@ -133,7 +109,7 @@ Each of the following are methods that the client sends to the remote signer.
 
 ### Requested permissions
 
-The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later.
+The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip44_encrypt,sign_event:4` meaning permissions to call `nip44_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string.
 
 ## Response Events `kind:24133`
 
@@ -141,14 +117,14 @@ The `connect` method may be provided with `optional_requested_permissions` for u
 {
     "id": <id>,
     "kind": 24133,
-    "pubkey": <remote_signer_pubkey>,
-    "content": <nip04(<response>)>,
-    "tags": [["p", <local_keypair_pubkey>]],
+    "pubkey": <remote-signer-pubkey>,
+    "content": <nip44(<response>)>,
+    "tags": [["p", <client-pubkey>]],
     "created_at": <unix timestamp in seconds>
 }
 ```
 
-The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure:
+The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure:
 
 ```json
 {
@@ -162,66 +138,90 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.c
 - `results` is a string of the result of the call (this can be either a string or a JSON stringified object)
 - `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request.
 
-### Auth Challenges
+## Example flow for signing an event
 
-An Auth Challenge is a response that a remote signer can send back when it needs the user to authenticate via other means. This is currently used in the OAuth-like flow enabled by signers like [Nsecbunker](https://github.com/kind-0/nsecbunkerd/). The response `content` object will take the following form:
+- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
+- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
+- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86`
 
-```json
+### Signature request
+
+```jsonc
 {
-    "id": <request_id>,
-    "result": "auth_url",
-    "error": <URL_to_display_to_end_user>
+    "kind": 24133,
+    "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
+    "content": nip44({
+        "id": <random_string>,
+        "method": "sign_event",
+        "params": [json_stringified(<{
+            content: "Hello, I'm signing remotely",
+            kind: 1,
+            tags: [],
+            created_at: 1714078911
+        }>)]
+    }),
+    "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey
 }
 ```
 
-Clients should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the remote signer (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). It's also possible to add a `redirect_uri` url parameter to the auth_url, which is helpful in situations when a client cannot open a new window or tab to display the auth challenge.
-
-#### Example event signing request with auth challenge
-
-![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png)
-
-## Remote Signer Commands
+### Response event
 
-Remote signers might support additional commands when communicating directly with it. These commands follow the same flow as noted above, the only difference is that when the client sends a request event, the `p`-tag is the pubkey of the remote signer itself and the `content` payload is encrypted to the same remote signer pubkey.
-
-### Methods/Commands
-
-Each of the following are methods that the client sends to the remote signer.
-
-| Command          | Params                                     | Result                               |
-| ---------------- | ------------------------------------------ | ------------------------------------ |
-| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` |
+```jsonc
+{
+    "kind": 24133,
+    "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
+    "content": nip44({
+        "id": <random_string>,
+        "result": json_stringified(<signed-event>)
+    }),
+    "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey
+}
+```
 
-## Appendix
+### Diagram
 
-### NIP-05 Login Flow
+![signing-example](https://i.nostr.build/P3gW.png)
 
-Clients might choose to present a more familiar login flow, so users can type a NIP-05 address instead of a `bunker://` string.
 
-When the user types a NIP-05 the client:
+## Auth Challenges
 
-- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the **remote user pubkey**)
-- In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on.
-- Now the client has enough information to send commands to the remote signer on behalf of the user.
+An Auth Challenge is a response that a _remote-signer_ can send back when it needs the _user_ to authenticate via other means. The response `content` object will take the following form:
 
-### OAuth-like Flow
+```json
+{
+    "id": <request_id>,
+    "result": "auth_url",
+    "error": <URL_to_display_to_end_user>
+}
+```
 
-#### Remote signer discovery via NIP-89
+_client_ should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the _remote-signer_ (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate).
 
-In this last case, most often used to facilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events.
+### Example event signing request with auth challenge
 
-First the client will query for `kind: 31990` events that have a `k` tag of `24133`.
+![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png)
 
-These are generally shown to a user, and once the user selects which remote signer to use and provides the remote user pubkey they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the remote signer that is actually managing the remote key that they would like to use in this case. If the remote user pubkey is managed on another remote signer, the connection will fail.
+## Appendix
 
-In addition, it's important that clients validate that the pubkey of the announced remote signer matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain.
+### Announcing _remote-signer_ metadata
 
-Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username.
+_remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this:
+```jsonc
+{
+    "names":{
+        "_": <remote-signer-app-pubkey>,
+    },
+    "nip46": {
+        "relays": ["wss://relay1","wss://relay2"...],
+        "nostrconnect_url": "https://remote-signer-domain.example/<nostrconnect>"
+    }
+}
+```
 
-#### Example Oauth-like flow to create a new user account with Nsecbunker
+The `<remote-signer-app-pubkey>` MAY be used to verify the domain from _remote-signer_'s NIP-89 event (see below). `relays` SHOULD be used to construct a more precise `nostrconnect://` string for the specific `remote-signer`. `nostrconnect_url` template MAY be used to redirect users to _remote-signer_'s connection flow by replacing `<nostrconnect>` placeholder with an actual `nostrconnect://` string.
 
-Coming soon...
+### Remote signer discovery via NIP-89
 
-## References
+_remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above.
 
-- [NIP-04 - Encryption](https://github.com/nostr-protocol/nips/blob/master/04.md)
+_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`.