taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-info-H_MAILBOX.rst (1716B)

      1 .. http:get:: /info/$H_MAILBOX
      2 
      3   Endpoint that returns mailbox metadata including signing and encryption keys for ``$H_MAILBOX``.
      4 
      5   **Response**
      6 
      7   :http:statuscode:`200 Ok`:
      8     Info is returned in a `MailboxMetadata` response,
      9   :http:statuscode:`404 Not Found`:
     10     This mailbox is not registered.
     11   :http:statuscode:`429 Too Many Requests`:
     12     The system is currently experiencing a too high request
     13     load and is unable to accept the message for delivery.
     14     The response body is a ``MailboxRateLimitedResponse`` as defined by the
     15     message-delivery endpoint.
     16 
     17 
     18   **Details:**
     19 
     20   .. _MailboxMetadata:
     21   .. ts:def:: MailboxMetadata
     22 
     23     interface MailboxMetadata {
     24 
     25       // The mailbox signing key.
     26       // Note that ``$H_MAILBOX == H(signing_key)``.
     27       // Note also how this key cannot be updated
     28       // as it identifies the mailbox.
     29       // Base32 crockford-encoded.
     30       signing_key: string;
     31 
     32       // Type of key.
     33       // Currently only
     34       // EdDSA keys are supported.
     35       signing_key_type: "EdDSA";
     36 
     37       // The mailbox encryption key.
     38       // This is a HPKE public key
     39       // Currently, only the X25519 format
     40       // for use in a X25519-DHKEM (RFC 9180)
     41       // is supported.
     42       // Base32 crockford-encoded.
     43       encryption_key: string;
     44 
     45       // Type of key.
     46       // Currently only
     47       // X25519 keys are supported.
     48       encryption_key_type: "X25519";
     49 
     50       // Expiration of this mailbox.
     51       // Unix epoch (seconds)
     52       expiration: Timestamp;
     53 
     54       // Optional info string that can be
     55       // chosen by the mailbox owner.
     56       // This may contain a Keyoxide proof for the mailbox
     57       // in order to link it to the owners profile
     58       info?: string;
     59     }