apps/irssi/docs/help/in/key.in

   1
   2 @SYNTAX:key@
   3
   4 This command is used to set and unset private keys for
   5 channels, set and unset private keys for private messages
   6 with remote clients and to send key agreement requests and
   7 negotiate the key agreement protocol with remote client.
   8 The key agreement is supported only to negotiate private
   9 message keys, it currently cannot be used to negotiate
  10 private keys for channels, as it is not convenient for that
  11 purpose.
  12
  13 Types:
  14
  15   MSG        The command is performed for private messages
  16              affecting the <nickname>.
  17
  18   CHANNEL    The command is performed for the channel indicated
  19              by <channel> (* matches current channel).
  20
  21 Commands:
  22
  23   set        [<key> [<cipher>] [<hmac>]]
  24
  25     Set the key into use.  The <key> is a pre-shared-key,
  26     passphrase or similar shared secret string.  Setting
  27     the key without first receiving a request from the
  28     remote user, this command will send the request to the
  29     remote user.  The actual key is not sent to network.
  30
  31     Optionally, the <cipher> and <hmac> may also be set.
  32
  33   unset      [<number>]
  34
  35     Unset the key.  The private key is not used after this
  36     command.  The key must be set again or the key material must
  37     be re-negotiated to be able to use the private keys again.
  38     The channel may have several private keys set.  The <number>
  39     can be used to indicate what key is being unset.  If it is
  40     not provided all keys are removed.
  41
  42   list
  43
  44     List all private keys that has been set.  If the type is
  45     MSG and the <nickname> is ´*' then all private message
  46     keys that you've set will be listed.
  47
  48   change     [<number>]
  49
  50     This command can be used only when type is CHANNEL.  This is
  51     used to change the current channel private key.  The <number>
  52     may indicate what key is changed.  If it is not provided then
  53     next key is changed to current channel private key.  By default
  54     this command is also bound to Meta-K (Alt+Shift+k) key.
  55
  56   agreement  [<hostname> [<port>] [<TCP|UDP>]]
  57
  58     Send key agreement request to remote client.  If the
  59     <hostname> is provided it is sent in the request. The
  60     receiver may use the hostname to start the key agreement.
  61     If the <port> is also provided your key agreement protocol
  62     server is bound to that port.  Note that it cannot be
  63     privileged port (<1024).  If the <hostname> and <port> is
  64     not provided then the receiver will never initiate the key
  65     agreement.  In this case you may start the key agreement
  66     after receiving the reply to the request, by giving the
  67     negotiate command.  By default the key agreement connection
  68     is TCP connection.  UDP connection may also be defined.
  69     (Note that, older SILC clients (1.0.x) does not support UDP).
  70
  71     This command may be used to send reply to the remote client.
  72     When receiving empty key agreement you can reply to the
  73     sender with the hostname and port of your key agreement
  74     server with this command.
  75
  76     If the hostname and port are ommitted, the boolean
  77     variable use_auto_addr will be examined.  If it is set
  78     the value of auto_bind_ip will be used as the IP address
  79     to listen for the return reply, the value of auto_public_ip
  80     will be the IP address sent to the remote client, and the
  81     auto_bind_port will be the port value to be bound to and
  82     sent to the remote client.  If auto_public_ip is unset, but
  83     auto_bind_ip is set, silc client will send the auto_bind_ip
  84     variable's value to the remote client.
  85
  86   negotiate  [<hostname> [<port>] [<TCP|UDP>]]
  87
  88     This may be called to start the key agreement with <nickname>.
  89     This command has effect only if the <nickname> has replied to
  90     your key agreement request.  You will see a notify on the
  91     screen when the reply arrives.  The <hostname> and <port> is the
  92     hostname and port of the remote client's key agreement server.
  93     The request tells the connection protocol used, usually TCP.
  94     If UDP was requested it must be provided.
  95
  96 Examples:
  97
  98   Set channel private key to current channel, and list all keys:
  99
 100     /KEY CHANNEL * set very_secret_key_this_is
 101     /KEY CHANNEL * list
 102
 103   Set private message key with a friend:
 104
 105     foobar:  /KEY MSG friend set secretkey
 106     friend:  /KEY MSG foobar set secretkey
 107
 108   Perform key agreement:
 109
 110     bar:  /KEY MSG foo agreement 10.2.1.7 5000
 111     foo:  /KEY MSG bar negotiate 10.2.1.7 5000
 112
 113     bar:  /KEY MSG foo agreement 10.2.1.7 5000 UDP
 114     foo:  /KEY MSG bar negotiate 10.2.1.7 5000 UDP
 115
 116 See also: WHOIS, CHANNEL, GETKEY