X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=apps%2Firssi%2Fdocs%2Fhelp%2Fin%2Fkey.in;h=06e115f51e3b7861604748937f79a73c95e42990;hb=52e57c880aba9c5e89f59d962eb9af75670b76e0;hp=92f9699941d31bc647c071e8a07eb30fa4597648;hpb=cdedc07c65bab8467f6f5b1ef4b38982c2c77571;p=silc.git diff --git a/apps/irssi/docs/help/in/key.in b/apps/irssi/docs/help/in/key.in index 92f96999..06e115f5 100644 --- a/apps/irssi/docs/help/in/key.in +++ b/apps/irssi/docs/help/in/key.in @@ -1,14 +1,12 @@ @SYNTAX:key@ -This command is used to set and unset private keys for -channels, set and unset private keys for private messages -with remote clients and to send key agreement requests and -negotiate the key agreement protocol with remote client. -The key agreement is supported only to negotiate private -message keys, it currently cannot be used to negotiate -private keys for channels, as it is not convenient for that -purpose. +This command is used to set and unset private channel keys, +set and unset private message keys with remote users, and +to send key agreement requests and negotiate the key agreement +protocol with remote user. The key agreement is supported only +to negotiate private message keys, it currently cannot be used +to negotiate channel private keys. Types: @@ -20,19 +18,15 @@ Types: Commands: - set [ [] []] [-responder] + set [ [] []] - Set the key into use. If the is provided it is used - as the key material. If the is not provided the - negotiated key material is used. If the negotiation has not - been performed this command has no effect. + Set the key into use. The is a pre-shared-key, + passphrase or similar shared secret string. Setting + the key without first receiving a request from the + remote user, this command will send the request to the + remote user. The actual key is not sent to network. - If the type is MSG and the is `*' then random key - will be generated automatically. The -responder option - may be used ONLY with MSG type. One of the clients must - be the responder side. The one being the responder must - use this option. The clients setting the key must agree - on which one is the responder. + Optionally, the and may also be set. unset [] @@ -57,7 +51,7 @@ Commands: next key is changed to current channel private key. By default this command is also bound to Meta-K (Alt+Shift+k) key. - agreement [ []] + agreement [ [] []] Send key agreement request to remote client. If the is provided it is sent in the request. The @@ -68,38 +62,53 @@ Commands: not provided then the receiver will never initiate the key agreement. In this case you may start the key agreement after receiving the reply to the request, by giving the - negotiate command. + negotiate command. By default the key agreement connection + is TCP connection. UDP connection may also be defined. + (Note that, older SILC clients (1.0.x) does not support UDP). This command may be used to send reply to the remote client. When receiving empty key agreement you can reply to the sender with the hostname and port of your key agreement server with this command. - If the hostname and port are ommitted, the irssi boolean + If the hostname and port are ommitted, the boolean variable use_auto_addr will be examined. If it is set the value of auto_bind_ip will be used as the IP address to listen for the return reply, the value of auto_public_ip will be the IP address sent to the remote client, and the auto_bind_port will be the port value to be bound to and sent to the remote client. If auto_public_ip is unset, but - auto_bind_ip is set, irssi will send the auto_bind_ip + auto_bind_ip is set, silc client will send the auto_bind_ip variable's value to the remote client. - negotiate [ []] + negotiate [ [] []] This may be called to start the key agreement with . This command has effect only if the has replied to your key agreement request. You will see a notify on the screen when the reply arrives. The and is the hostname and port of the remote client's key agreement server. + The request tells the connection protocol used, usually TCP. + If UDP was requested it must be provided. Examples: Set channel private key to current channel, and list all keys: - /KEY CHANNEL set very_secret_key_this_is - /KEY CHANNEL list - /KEY MSG nickname set secretkey - /KEY MSG nick set secretkey -responder - /KEY MSG foo agreement 10.2.1.7 5000 - /KEY MSG bar negotiate 10.2.1.7 5000 + /KEY CHANNEL * set very_secret_key_this_is + /KEY CHANNEL * list + + Set private message key with a friend: + + foobar: /KEY MSG friend set secretkey + friend: /KEY MSG foobar set secretkey + + Perform key agreement: + + bar: /KEY MSG foo agreement 10.2.1.7 5000 + foo: /KEY MSG bar negotiate 10.2.1.7 5000 + + bar: /KEY MSG foo agreement 10.2.1.7 5000 UDP + foo: /KEY MSG bar negotiate 10.2.1.7 5000 UDP + +See also: WHOIS, CHANNEL, GETKEY