doc/silc.yo

   1 manpage(SILC) (1) (October 31 2002) (silc-client-0.9.7) (silc-client)
   2
   3
   4 manpagename(silc) (client for SILC, a secure and flexible conferencing network)
   5
   6
   7 manpagesynopsis()
   8 bf(silc) bf([) -S em(file) | -d | -C | -c em(host) | -w em(pass) |
   9 -p em(port) | -! | -n em(nick) | -h em(host) | -v | -? bf(])
  10
  11
  12 manpagedescription()
  13 SILC (Secure Internet Live Conferencing) is a secure conferencing network.
  14 bf(Silc) is the SILC client which is used to connect to SILC server and
  15 the SILC network.  The silc client resembles IRC clients to make the
  16 using easier for new users.
  17
  18 bf(Silc) supports sending of practically any kind of messages in addition
  19 of normal text messages in the SILC network.  The session to SILC server
  20 is secured with session key, channel messages are protected with channel
  21 key and private messages with session keys.  It is also possible to use
  22 private channel keys and private message keys in addition of server
  23 generated keys.
  24
  25 bf(Silc) supports em(passphrase) and public key authentication based on
  26 em(digital signatures), when connecting to SILC server.  bf(Silc) also supports
  27 key exchange (key agreement) between other bf(Silc) users in the SILC
  28 network to negotiate secret key material.  This key material then can be
  29 used to secure for example private messages.  It is also possible to exchange
  30 public keys and certificates in the SILC network between clients and servers.
  31
  32 The bf(silc) also supports em(detaching) from the SILC network by closing
  33 the connection to the server but without quitting from the network.  Next
  34 time the bf(silc) connects to the server it em(resumes) the session in the
  35 SILC network.  During the detaching the user remains in the network and other
  36 users may query the user information and see that user is in network but
  37 currently detached.  Messages sent to user while being detached are
  38 dropped by the server.  When resuming is over the user has automatically
  39 same nickname than before detaching and remains on all channels, and it
  40 seems like user never left the network.
  41
  42 The bf(silc) also supports creation of em(friends) list, which is kind of
  43 a buddy list familiar from IM (Instant Messaging) clients.  By using the
  44 bf(WHOIS) SILC command with em(-details) option it is possible to fetch the
  45 user's information such as their public keys and certificates, business
  46 card, pictures, and other information and save them to the friends list.
  47 The friends list is located at bf(~/.silc/friends/) directory.
  48
  49 The SILC public key and private key pair is used to authenticate the user
  50 to the SILC server when connecting a server.  This key pair is created
  51 automatically when the bf(silc) is run for the first time.  It also can
  52 be created with bf(-C) option.
  53
  54 When connecting for the first time to SILC server, user will be asked to
  55 accept the server's public key.  When key is accepted the bf(silc) saves
  56 the public key for future into bf(~/.silc/serverkeys/) directory.  The
  57 next time user connects to same server the public key is verified against
  58 the saved public key.  The purpose of this public key saving is to avoid
  59 man-in-the-middle attacks which could be possible if the key would have
  60 to be verified every time user connects to the server.
  61
  62 manpageoptions()
  63 bf(-c) em(host)      Connect to given host
  64
  65 bf(-p) em(port)      Connect to em(port)
  66
  67 bf(-C)           Create new public key pair
  68
  69 bf(-P)           Change the passphrase of the private key file
  70
  71 bf(-S) em(keyfile)   Display the contents of given SILC public key from file
  72
  73 bf(-n) em(nick)      Specify what nick to use
  74
  75 bf(-h) em(host)      Give em(host) as your hostname
  76
  77 bf(-w) em(pass)      Use em(pass) as password for connection
  78
  79 bf(-d) em(string)    Enable debugging
  80
  81 bf(-v)           Display client version
  82
  83 bf(-!)           Do not autoconnect
  84
  85 bf(-?)           Display client help message
  86
  87
  88 manpagesection(LONG OPTIONS)
  89
  90 bf(--connect)=em(SERVER)     Same as bf(-c).
  91
  92 bf(--port)=em(PORT)          Same as bf(-p).
  93
  94 bf(--home)=em(PATH)          Client home dir (em(~/.silc)).
  95
  96 bf(--config)=em(PATH)        Configuration file location (em(~/.silc/silc.conf)).
  97
  98 bf(--list-ciphers)       List supported ciphers.
  99
 100 bf(--list-hash-funcs)    List supported hash functions.
 101
 102 bf(--list-hmacs)         List supported HMACs.
 103
 104 bf(--list-pkcs)          List supported PKCSs.
 105
 106 bf(--create-key-pair)    Same as bf(-C).
 107
 108 bf(--passphrase-change)  Same as bf(-P).
 109
 110 bf(--nick)=em(NICK)          Same as bf(-n).
 111
 112 bf(--hostname)=em(HOST)      Same as bf(-h).
 113
 114 bf(--password)=em(PASS)      Same as bf(-w).
 115
 116 bf(--debug)=em(STRING)       Same as bf(-d), limit to messages *em(STRING)*.
 117
 118 bf(--dummy)              Use dummy terminal mode.
 119
 120 bf(--version)            Same as bf(-v).
 121
 122 bf(--noconnect)          Same as bf(-!).
 123
 124 bf(--help)               Same as bf(-?).
 125
 126 bf(--usage)              Display very brief usage summary.
 127
 128
 129 manpagesection(KEY GENERATION)
 130 When generating key pair(s) for silc (bf(-C)), the following extra
 131 switches apply:
 132
 133 bf(--pkcs)=em(PKCS)       Set the public key algorithm of key pair.  For example bf(rsa).
 134
 135 bf(--bits)=em(VALUE)       Set the length of public key pair, in bits.
 136
 137
 138 manpagesection(CONFIGURATION FILE)
 139 The bf(silc) configuration file is bf(~/.silc/silc.conf) and can be used
 140 to configure the behavriou of the client.  The configuration file format
 141 is equivalent to Irssi IRC client's configuration file.  See the
 142 documentation for the configuration file at bf(http://irssi.org).
 143
 144 There are a few bf(silc) configuration settings in em(silc.conf) which
 145 can be configured in em(settings) section under em("server") block.
 146 They can be set also with the bf(/SET) command in the bf(silc) client.
 147
 148 bf(crypto_default_cipher)
 149 quote(The default cipher to use to secure the session to the server.
 150 Values can be for example bf(aes-256-cbc), bf(aes-192-cbc), bf(aes-128-cbc),
 151 bf(twofish-256-cbc), bf(twofish-192-cbc), bf(twofish-128-cbc).)
 152
 153 bf(crypto_default_hash)
 154 quote(The default hash function to use in session with the server. Values
 155 can be bf(sha1) or bf(md5).)
 156
 157 bf(crypto_default_hmac)
 158 quote(The default HMAC to be use in session with the server.  Value can
 159 be bf(hmac-sha1-96), bf(hmac-md5-96), bf(hmac-sha1) or bf(hmac-md5).)
 160
 161
 162 manpagefiles()
 163 bf(~/.silc/silc.conf)
 164 quote(Client's configuration file)
 165
 166 bf(~/.silc/public_key.pub)
 167 quote(The SILC public key of the user)
 168
 169 bf(~/.silc/private_key.pub)
 170 quote(The SILC private key of the user)
 171
 172 bf(~/.silc/clientkeys/)
 173 quote(The directory holding the public keys of other users the user have
 174 accepted and trusted in the SILC network.  The public keys can be received
 175 with bf(GETKEY) SILC command or during key agreement between two users.)
 176
 177 bf(~/.silc/clientkeys/)
 178 quote(The directory holding the public keys of servers the user have accepted
 179 and trusted when connecting to a server.)
 180
 181 bf(~/.silc/friends/)
 182 quote(The directory holding the information of em(friends) that user has.
 183 User can create a friend list with bf(WHOIS -details) SILC command.  This
 184 directory holds the friends' public keys, business cards, pictures, and
 185 other information.)
 186
 187
 188 manpageseealso()
 189 bf(silcd(8)) bf(silcd.conf(5))
 190
 191
 192 manpagesection(NETWORK RESOURCES)
 193 Homepage: bf(http://silcnet.org)
 194
 195 SILC Client is based on Irssi IRC client: bf(http://irssi.org)
 196
 197 User's guide: bf(http://silcnet.org/docs/)
 198
 199
 200 manpageauthor()
 201 SILC is designed and written by Pekka Riikonen <priikone@iki.fi> and rest
 202 of the SILC Project.
 203
 204 This manpage was written by Mika 'Bostik' Boström <bostik@lut.fi>
 205
 206 See bf(CREDITS) for full list of contributors.
 207
 208