| 1 | .\" -*-nroff-*- |
| 2 | .\". |
| 3 | .\" Manual for the administration protocol |
| 4 | .\" |
| 5 | .\" (c) 2008 Straylight/Edgeware |
| 6 | .\" |
| 7 | . |
| 8 | .\"----- Licensing notice --------------------------------------------------- |
| 9 | .\" |
| 10 | .\" This file is part of Trivial IP Encryption (TrIPE). |
| 11 | .\" |
| 12 | .\" TrIPE is free software: you can redistribute it and/or modify it under |
| 13 | .\" the terms of the GNU General Public License as published by the Free |
| 14 | .\" Software Foundation; either version 3 of the License, or (at your |
| 15 | .\" option) any later version. |
| 16 | .\" |
| 17 | .\" TrIPE is distributed in the hope that it will be useful, but WITHOUT |
| 18 | .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 19 | .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 20 | .\" for more details. |
| 21 | .\" |
| 22 | .\" You should have received a copy of the GNU General Public License |
| 23 | .\" along with TrIPE. If not, see <https://www.gnu.org/licenses/>. |
| 24 | . |
| 25 | .\"-------------------------------------------------------------------------- |
| 26 | .so ../common/defs.man \" @@@PRE@@@ |
| 27 | . |
| 28 | .\"-------------------------------------------------------------------------- |
| 29 | .TH tripe-admin 5tripe "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" |
| 30 | . |
| 31 | .\"-------------------------------------------------------------------------- |
| 32 | .SH "NAME" |
| 33 | . |
| 34 | tripe-admin \- administrator commands for TrIPE |
| 35 | . |
| 36 | .\"-------------------------------------------------------------------------- |
| 37 | .SH "DESCRIPTION" |
| 38 | . |
| 39 | This manual page describes the administration interface provided by the |
| 40 | .BR tripe (8) |
| 41 | daemon. |
| 42 | .PP |
| 43 | The |
| 44 | .BR tripectl (8) |
| 45 | program can be used either interactively or in scripts to communicate |
| 46 | with the server using this interface. Alternatively, simple custom |
| 47 | clients can be written in scripting languages such as Perl, Python or |
| 48 | Tcl, or more advanced clients such as GUI monitors can be written in C |
| 49 | with little difficulty. |
| 50 | .PP |
| 51 | Administration commands use a textual protocol. Each client command or |
| 52 | server response consists of a line of ASCII text terminated by a single |
| 53 | linefeed character. No command may be longer than 255 characters. |
| 54 | .SS "General structure" |
| 55 | Each command or response line consists of a sequence of |
| 56 | whitespace-separated tokens. The number and nature of whitespace |
| 57 | characters separating two tokens in a client command is not significant; |
| 58 | the server always uses a single space character. The first token in a |
| 59 | line is a |
| 60 | .I keyword |
| 61 | identifying the type of command or response contained. Keywords in |
| 62 | client commands are not case-sensitive; the server always uses uppercase |
| 63 | for its keywords. |
| 64 | .PP |
| 65 | In order to allow tokens to contain internal whitespace, a quoting |
| 66 | mechanism is provided. Whitespace within matched pairs of quotes \(en |
| 67 | either single |
| 68 | .RB ` ' ' |
| 69 | or double |
| 70 | .RB ` """" ' |
| 71 | \(en is considered to be internal. Any character (other than newline) |
| 72 | may be escaped by preceding it with a backslash |
| 73 | .RB ` \e ': |
| 74 | in particular, this can be used to include quote characters. It is |
| 75 | impossible for a token to contain a newline character. |
| 76 | .PP |
| 77 | On output, the server will use double quotes when necessary. |
| 78 | .SS "Simple commands" |
| 79 | For simple client command, the server responds with zero or more |
| 80 | .B INFO |
| 81 | lines, followed by either an |
| 82 | .B OK |
| 83 | line or a |
| 84 | .B FAIL |
| 85 | line. Each |
| 86 | .B INFO |
| 87 | provides information requested in the command. An |
| 88 | .B OK |
| 89 | response contains no further data. A |
| 90 | .B FAIL |
| 91 | code is followed by a machine-readable explanation of why the command |
| 92 | failed. |
| 93 | .PP |
| 94 | Simple command processing is strictly synchronous: the server reads a |
| 95 | command, processes it, and responds, before reading the next command. |
| 96 | All commands can be run as simple commands. Long-running commands |
| 97 | (e.g., |
| 98 | .B ADD |
| 99 | and |
| 100 | .BR PING ) |
| 101 | block the client until they finish, but the rest of the server continues |
| 102 | running. See |
| 103 | .B "Background commands" |
| 104 | to find out how to issue long-running commands without blocking. |
| 105 | .SS "Asynchronous broadcasts" |
| 106 | There are three types of asynchronous broadcast messages which aren't |
| 107 | associated with any particular command. Clients can select which |
| 108 | broadcast messages they're interested in using the |
| 109 | .B WATCH |
| 110 | command. |
| 111 | .PP |
| 112 | The |
| 113 | .B WARN |
| 114 | message contains a machine-readable message warning of an error |
| 115 | encountered while processing a command, unexpected or unusual behaviour |
| 116 | by a peer, or a possible attack by an adversary. Under normal |
| 117 | conditions, the server shouldn't emit any warnings. |
| 118 | .PP |
| 119 | The |
| 120 | .B TRACE |
| 121 | message contains a human-readable tracing message containing diagnostic |
| 122 | information. Trace messages are controlled using the |
| 123 | .B \-T |
| 124 | command-line option to the server, or the |
| 125 | .B TRACE |
| 126 | administration command (see below). Support for tracing can be disabled |
| 127 | when the package is being configured, and may not be available in your |
| 128 | version. |
| 129 | .PP |
| 130 | Finally, the |
| 131 | .B NOTE |
| 132 | message is a machine-readable notification about some routine but |
| 133 | interesting event such as creation or destruction of peers. |
| 134 | .SS "Background commands" |
| 135 | Some commands (e.g., |
| 136 | .B ADD |
| 137 | and |
| 138 | .BR PING ) |
| 139 | take a long time to complete. To prevent these long-running commands |
| 140 | from tying up a server connection, they can be run in the background. |
| 141 | Not all commands can be run like this: the ones that can provide a |
| 142 | .B \-background |
| 143 | option, which must be supplied with a |
| 144 | .IR tag . |
| 145 | .PP |
| 146 | A command may fail before it starts running in the background. In this |
| 147 | case, the server emits a |
| 148 | .B FAIL |
| 149 | response, as usual. To indicate that a command has started running in |
| 150 | the background, the server emits a response of the form |
| 151 | .BI "BGDETACH " tag \fR, |
| 152 | where |
| 153 | .I tag |
| 154 | is the value passed to the |
| 155 | .B \-background |
| 156 | option. From this point on, the server is ready to process more |
| 157 | commands and reply to them. |
| 158 | .PP |
| 159 | Responses to background commands are indicated by a line beginning with |
| 160 | one of the tokens |
| 161 | .BR BGOK , |
| 162 | .BR BGFAIL , |
| 163 | or |
| 164 | .BR BGINFO , |
| 165 | followed by the command tag. These correspond to the |
| 166 | .BR OK , |
| 167 | .BR FAIL , |
| 168 | and |
| 169 | .B INFO |
| 170 | responses for simple commands: |
| 171 | .B BGINFO |
| 172 | indicates information from a background command which has not completed |
| 173 | yet; and |
| 174 | .B BGOK |
| 175 | and |
| 176 | .B BGFAIL |
| 177 | indicates that a background command succeeded or failed, respectively. |
| 178 | .PP |
| 179 | A background command will never issue an |
| 180 | .B OK |
| 181 | or |
| 182 | .B INFO |
| 183 | response: it will always detach and then issue any |
| 184 | .B BGINFO |
| 185 | lines followed by |
| 186 | .B BGOK |
| 187 | response. |
| 188 | .SS "Client-provided services" |
| 189 | .\"* 25 Service-related messages |
| 190 | An administration client can provide services to other clients. |
| 191 | Services are given names and versions. A client can attempt to |
| 192 | .I claim |
| 193 | a particular service by issuing the |
| 194 | .B SVCCLAIM |
| 195 | command. This may fail, for example, if some other client already |
| 196 | provides the same or later version of the service. |
| 197 | .PP |
| 198 | Other clients can issue |
| 199 | .I "service commands" |
| 200 | using the |
| 201 | .B "SVCSUBMIT" |
| 202 | command; the service provider is expected to handle these commands and |
| 203 | reply to them. |
| 204 | .PP |
| 205 | There are three important asynchronous messages which will be sent to |
| 206 | service providers. |
| 207 | .SP |
| 208 | .BI "SVCCANCEL " jobid |
| 209 | The named job has been cancelled, either because the issuing client has |
| 210 | disconnected or explicitly cancelled the job using the |
| 211 | .B BGCANCEL |
| 212 | command. |
| 213 | .SP |
| 214 | .BI "SVCCLAIM " service " " version |
| 215 | Another client has claimed a later version of the named |
| 216 | .IR service . |
| 217 | The recipient is no longer the provider of this service. |
| 218 | .SP |
| 219 | .BI "SVCJOB " jobid " " service " " command " " args \fR... |
| 220 | Announces the arrival of a new job. The |
| 221 | .I jobid |
| 222 | is a simple token consisting of alphanumeric characters which |
| 223 | .B tripe |
| 224 | uses to identify this job. |
| 225 | .PP |
| 226 | The service provider can reply to the job using the commands |
| 227 | .BR SVCINFO , |
| 228 | .B SVCOK |
| 229 | and |
| 230 | .BR SVCFAIL . |
| 231 | The first of these sends an |
| 232 | .B INFO |
| 233 | response and leaves the job active; the other two send an |
| 234 | .B OK |
| 235 | or |
| 236 | .B FAIL |
| 237 | response respectively, and mark the job as being complete. |
| 238 | .PP |
| 239 | (Since |
| 240 | .B SVCSUBMIT |
| 241 | is a potentially long-running command, it can be run in the background. |
| 242 | This detail is hidden from service providers: |
| 243 | .B tripe |
| 244 | will issue the corresponding |
| 245 | .BR BG ... |
| 246 | responses when appropriate.) |
| 247 | .SS "Network addresses" |
| 248 | A network address is a sequence of tokens. The first is a token |
| 249 | identifying the network address family. The length of an address and |
| 250 | the meanings of the subsequent tokens depend on the address family. |
| 251 | Address family tokens are not case-sensitive on input; on output, they |
| 252 | are always in upper-case. |
| 253 | .PP |
| 254 | At present, only one address family is understood. |
| 255 | .TP |
| 256 | .BI "INET " address " \fR[" port \fR] |
| 257 | An Internet socket, naming an IPv4 address and UDP port. On output, the |
| 258 | address is always in numeric dotted-quad form, and the port is given as |
| 259 | a plain number. On input, DNS hostnames and symbolic port names are |
| 260 | permitted; if omitted, the default port 4070 is used. Name resolution |
| 261 | does not block the main server, but will block the requesting client, |
| 262 | unless the command is run in the background. |
| 263 | .PP |
| 264 | If, on input, no recognized address family token is found, the following |
| 265 | tokens are assumed to represent an |
| 266 | .B INET |
| 267 | address. Addresses output by the server always have an address family |
| 268 | token. |
| 269 | .SS "Key-value output" |
| 270 | Some commands (e.g., |
| 271 | .B STATS |
| 272 | and |
| 273 | .BR SERVINFO ) |
| 274 | produce output in the form of |
| 275 | .IB key = value |
| 276 | pairs, one per token. Neither the |
| 277 | .I key |
| 278 | nor the |
| 279 | .I value |
| 280 | contain spaces. |
| 281 | .SS "Trace lists" |
| 282 | Commands which enable or disable kinds of output (e.g., |
| 283 | .B TRACE |
| 284 | and |
| 285 | .BR WATCH ) |
| 286 | work in similar ways. They take a single optional argument, which |
| 287 | consists of a string of letters selecting message types, optionally |
| 288 | interspersed with |
| 289 | .RB ` + ' |
| 290 | to enable, or |
| 291 | .RB ` \- ' |
| 292 | to disable, the subsequently listed types. |
| 293 | .PP |
| 294 | If the argument is omitted, the available message types are displayed, |
| 295 | one to an |
| 296 | .B INFO |
| 297 | line, in a fixed-column format. Column zero contains the key letter for |
| 298 | selecting that message type; column one contains either a space or a |
| 299 | .RB ` + ' |
| 300 | sign, if the message type is disabled or enabled respectively; and a |
| 301 | textual description of the message type begins at column 3 and continues |
| 302 | to the end of the line. |
| 303 | .PP |
| 304 | Lowercase key letters control individual message types. Uppercase key |
| 305 | letters control collections of message types. |
| 306 | . |
| 307 | .\"-------------------------------------------------------------------------- |
| 308 | .SH "COMMAND REFERENCE" |
| 309 | . |
| 310 | .\"* 10 Commands |
| 311 | The commands provided are: |
| 312 | .SP |
| 313 | .BI "ADD \fR[" options "\fR] " peer " " address "\fR..." |
| 314 | Adds a new peer. The peer is given the name |
| 315 | .IR peer ; |
| 316 | the peer's public key is assumed to be in the file |
| 317 | .B keyring.pub |
| 318 | (or whatever alternative file was specified in the |
| 319 | .B \-K |
| 320 | option on the command line). The |
| 321 | .I address |
| 322 | is the network address (see above for the format) at which the peer can |
| 323 | be contacted. The following options are recognized. |
| 324 | .RS |
| 325 | .\"+opts |
| 326 | .TP |
| 327 | .BI "\-background " tag |
| 328 | Run the command in the background, using the given |
| 329 | .IR tag . |
| 330 | .TP |
| 331 | .B "\-cork" |
| 332 | Don't send an immediate challenge to the peer; instead, wait until it |
| 333 | sends us something before responding. |
| 334 | .TP |
| 335 | .BI "\-keepalive " time |
| 336 | Send a no-op packet if we've not sent a packet to the peer in the last |
| 337 | .I time |
| 338 | interval. This is useful for persuading port-translating firewalls to |
| 339 | believe that the `connection' is still active. The |
| 340 | .I time |
| 341 | is expressed as a nonnegative integer followed optionally by |
| 342 | .BR d , |
| 343 | .BR h , |
| 344 | .BR m , |
| 345 | or |
| 346 | .BR s |
| 347 | for days, hours, minutes, or seconds respectively; if no suffix is |
| 348 | given, seconds are assumed. |
| 349 | .TP |
| 350 | .BI "\-key " tag |
| 351 | Use the public key |
| 352 | .I tag |
| 353 | to authenticate the peer. The default is to use the key tagged |
| 354 | .IR peer . |
| 355 | .TP |
| 356 | .B "\-mobile" |
| 357 | The peer is a mobile device, and is likely to change address rapidly. |
| 358 | If a packet arrives from an unknown address, the server's usual response |
| 359 | is to log a warning and discard it. If the server knows of any mobile |
| 360 | peers, however, it will attempt to decrypt the packet using their keys, |
| 361 | and if one succeeds, the server will update its idea of the peer's |
| 362 | address and emit an |
| 363 | .B NEWADDR |
| 364 | notification. |
| 365 | .TP |
| 366 | .BI "\-priv " tag |
| 367 | Use the private key |
| 368 | .I tag |
| 369 | to authenticate to the peer. The default is to use the key named in the |
| 370 | .RB ` \-t ' |
| 371 | command-line option, or a key with type |
| 372 | .B tripe |
| 373 | or |
| 374 | .BR tripe-dh : |
| 375 | see |
| 376 | .BR tripe (8) |
| 377 | for the details. |
| 378 | .TP |
| 379 | .BI "\-tunnel " tunnel |
| 380 | Use the named tunnel driver, rather than the default. |
| 381 | .\"-opts |
| 382 | .RE |
| 383 | .SP |
| 384 | .BI "ADDR " peer |
| 385 | Emits an |
| 386 | .B INFO |
| 387 | line reporting the IP address and port number stored for |
| 388 | .IR peer . |
| 389 | .SP |
| 390 | .BI "ALGS \fR[" peer \fR] |
| 391 | Emits information about the cryptographic algorithms in use, in |
| 392 | key-value form. If a |
| 393 | .I peer |
| 394 | is given, then describe the algorithms used in the association with that |
| 395 | peer; otherwise describe the default algorithms. |
| 396 | .RS |
| 397 | .PP |
| 398 | The keys are as follows. |
| 399 | .TP |
| 400 | .B kx-group |
| 401 | Type of key-exchange group in use, currently either |
| 402 | .B ec |
| 403 | or |
| 404 | .BR prime . |
| 405 | .TP |
| 406 | .B kx-group-order-bits |
| 407 | Length of the group order, in bits. This gives an approximate measure |
| 408 | of the group strength. |
| 409 | .TP |
| 410 | .B kx-group-elt-bits |
| 411 | Length of a group element, in bits. This may be useful when analyzing |
| 412 | protocol traces. |
| 413 | .TP |
| 414 | .B hash |
| 415 | The hash function in use, e.g., |
| 416 | .BR sha256 . |
| 417 | .TP |
| 418 | .B mgf |
| 419 | The mask-generating function in use, e.g., |
| 420 | .BR whirlpool-mgf . |
| 421 | .TP |
| 422 | .B hashsz |
| 423 | The size of the hash function's output, in octets. |
| 424 | .TP |
| 425 | .B bulk-transform |
| 426 | The name of the bulk-crypto transform. |
| 427 | .TP |
| 428 | .B bulk-overhead |
| 429 | The amount of overhead, in bytes, caused by the crypto transform. |
| 430 | .TP |
| 431 | .B cipher |
| 432 | The name of the bulk data cipher in use, e.g., |
| 433 | .BR blowfish-cbc . |
| 434 | .TP |
| 435 | .B cipher-keysz |
| 436 | The length of key used by the bulk data cipher, in octets. |
| 437 | .TP |
| 438 | .B cipher-blksz |
| 439 | The block size of the bulk data cipher, or zero if it's not based on a |
| 440 | block cipher. |
| 441 | .TP |
| 442 | .B cipher-data-limit |
| 443 | The maximum amount of data to be encrypted using a single key. (A new |
| 444 | key exchange is instigated well before the limit is reached, in order to |
| 445 | allow for a seamless changeover of keys.) |
| 446 | .TP |
| 447 | .B mac |
| 448 | The message authentication algorithm in use, e.g., |
| 449 | .BR ripemd160-hmac . |
| 450 | .TP |
| 451 | .B mac-keysz |
| 452 | The length of the key used by the message authentication algorithm, in |
| 453 | octets. |
| 454 | .TP |
| 455 | .B mac-tagsz |
| 456 | The length of the message authentication tag, in octets. |
| 457 | .TP |
| 458 | .B blkc |
| 459 | The block cipher in use, e.g., |
| 460 | .BR blowfish . |
| 461 | .TP |
| 462 | .B blkc-keysz |
| 463 | The length of key used by the block cipher, in octets. |
| 464 | .TP |
| 465 | .B blkc-blksz |
| 466 | The block size of the block cipher. |
| 467 | .PP |
| 468 | The various sizes are useful, for example, when computing the MTU for a |
| 469 | tunnel interface. If |
| 470 | .I MTU |
| 471 | is the MTU of the path to the peer, then the tunnel MTU should be |
| 472 | .IP |
| 473 | .I MTU |
| 474 | \- 29 \- |
| 475 | .I bulk-overhead |
| 476 | .PP |
| 477 | allowing 20 bytes of IP header, 8 bytes of UDP header, a packet type |
| 478 | octet, and the bulk-crypto transform overhead (which includes the |
| 479 | sequence number). |
| 480 | .RE |
| 481 | .SP |
| 482 | .BI "BGCANCEL " tag |
| 483 | Cancels the background job with the named |
| 484 | .IR tag . |
| 485 | .SP |
| 486 | .BI "CHECKCHAL " challenge |
| 487 | Verifies a challenge as being one earlier issued by |
| 488 | .B GETCHAL |
| 489 | and not previously either passed to |
| 490 | .B CHECKCHAL |
| 491 | or in a greeting message. |
| 492 | .SP |
| 493 | .B "DAEMON" |
| 494 | Causes the server to disassociate itself from its terminal and become a |
| 495 | background task. This only works once. A notification is issued. |
| 496 | .SP |
| 497 | .BI "EPING \fR[" options "\fR] " peer |
| 498 | Sends an encrypted ping to the peer, and expects an encrypted response. |
| 499 | This checks that the peer is running (and not being impersonated), and |
| 500 | that it can encrypt and decrypt packets correctly. Options and |
| 501 | responses are the same as for the |
| 502 | .B PING |
| 503 | command. |
| 504 | .SP |
| 505 | .BI "FORCEKX " peer |
| 506 | Requests the server to begin a new key exchange with |
| 507 | .I peer |
| 508 | immediately. |
| 509 | .SP |
| 510 | .B "GETCHAL" |
| 511 | Requests a challenge. The challenge is returned in an |
| 512 | .B INFO |
| 513 | line, as a base64-encoded string. See |
| 514 | .BR CHECKCHAL . |
| 515 | .SP |
| 516 | .BI "GREET " peer " " challenge |
| 517 | Sends a greeting packet containing the |
| 518 | .I challenge |
| 519 | (base-64 encoded) to the named |
| 520 | .IR peer . |
| 521 | The expectation is that this will cause the peer to recognize us and |
| 522 | begin a key-exchange. |
| 523 | .SP |
| 524 | .B "HELP" |
| 525 | Causes the server to emit an |
| 526 | .B INFO |
| 527 | line for each command it supports. Each line lists the command name, |
| 528 | followed by the names of the arguments. This may be helpful as a memory |
| 529 | aid for interactive use, or for program clients probing for features. |
| 530 | .SP |
| 531 | .BI "IFNAME " peer |
| 532 | Emits an |
| 533 | .B INFO |
| 534 | line containing the name of the network interface used to collect IP |
| 535 | packets which are to be encrypted and sent to |
| 536 | .IR peer . |
| 537 | Used by configuration scripts so that they can set up routing tables |
| 538 | appropriately after adding new peers. |
| 539 | .SP |
| 540 | .B "JOBS" |
| 541 | Emits an |
| 542 | .B INFO |
| 543 | line giving the tag for each outstanding background job. |
| 544 | .SP |
| 545 | .BI "KILL " peer |
| 546 | Causes the server to forget all about |
| 547 | .IR peer . |
| 548 | All keys are destroyed, and no more packets are sent. No notification |
| 549 | is sent to the peer: if it's important that the peer be notified, you |
| 550 | must think of a way to do that yourself. |
| 551 | .SP |
| 552 | .B "LIST" |
| 553 | For each currently-known peer, an |
| 554 | .B INFO |
| 555 | line is written containing the peer's name, as given to |
| 556 | .BR ADD . |
| 557 | .SP |
| 558 | .BI "NOTIFY " tokens\fR... |
| 559 | Issues a |
| 560 | .B USER |
| 561 | notification to all interested administration clients. |
| 562 | .SP |
| 563 | .BI "PEERINFO " peer |
| 564 | Returns information about a peer, in key-value form. The following keys |
| 565 | are returned. |
| 566 | .RS |
| 567 | .TP |
| 568 | .B tunnel |
| 569 | The tunnel driver used for this peer. |
| 570 | .TP |
| 571 | .B keepalive |
| 572 | The keepalive interval, in seconds, or zero if no keepalives are to be |
| 573 | sent. |
| 574 | .TP |
| 575 | .B key |
| 576 | The (short) key tag being used for the peer, as passed to the |
| 577 | .B ADD |
| 578 | command. |
| 579 | .TP |
| 580 | .B current-key |
| 581 | The full key tag of the peer's public key currently being used. This |
| 582 | may change during the life of the association. |
| 583 | .TP |
| 584 | .B private-key |
| 585 | The private key tag being used for the peer, as passed to the |
| 586 | .B ADD |
| 587 | command, or the |
| 588 | .RB ` \-t ' |
| 589 | command-line option. If neither of these was given explicitly, the |
| 590 | private key tag is shown as |
| 591 | .RB ` (default) ', |
| 592 | since there is no fixed tag used under these circumstances. |
| 593 | .TP |
| 594 | .B current-private-key |
| 595 | The full key tag of the private key currently being used for this |
| 596 | association. This may change during the life of the association. |
| 597 | .TP |
| 598 | .B corked |
| 599 | Either |
| 600 | .B t |
| 601 | or |
| 602 | .B nil |
| 603 | depending on whether or not (respectively) key-exchange is waiting for |
| 604 | the peer to initiate. |
| 605 | .TP |
| 606 | .B mobile |
| 607 | Either |
| 608 | .B t |
| 609 | or |
| 610 | .B nil |
| 611 | depending on whether or not (respectively) the peer is expected to |
| 612 | change its address unpredictably. |
| 613 | .RE |
| 614 | .SP |
| 615 | .BI "PING \fR[" options "\fR] " peer |
| 616 | Send a transport-level ping to the peer. The ping and its response are |
| 617 | not encrypted or authenticated. This command, possibly in conjunction |
| 618 | with tracing, is useful for ensuring that UDP packets are actually |
| 619 | flowing in both directions. See also the |
| 620 | .B EPING |
| 621 | command. |
| 622 | .IP |
| 623 | An |
| 624 | .B INFO |
| 625 | line is printed describing the outcome: |
| 626 | .RS |
| 627 | .TP |
| 628 | .BI "ping-ok " millis |
| 629 | A response was received |
| 630 | .I millis |
| 631 | after the ping was sent. |
| 632 | .TP |
| 633 | .BI "ping-timeout" |
| 634 | No response was received within the time allowed. |
| 635 | .TP |
| 636 | .BI "ping-peer-died" |
| 637 | The peer was killed (probably by another admin connection) before a |
| 638 | response was received. |
| 639 | .RE |
| 640 | .IP |
| 641 | Options recognized for this command are: |
| 642 | .RS |
| 643 | .\"+opts |
| 644 | .TP |
| 645 | .BI "\-background " tag |
| 646 | Run the command in the background, using the given |
| 647 | .IR tag . |
| 648 | .TP |
| 649 | .BI "\-timeout " time |
| 650 | Wait for |
| 651 | .I time |
| 652 | seconds before giving up on a response. The default is 5 seconds. The |
| 653 | .I time |
| 654 | is expressed as a nonnegative integer followed optionally by |
| 655 | .BR d , |
| 656 | .BR h , |
| 657 | .BR m , |
| 658 | or |
| 659 | .BR s |
| 660 | for days, hours, minutes, or seconds respectively; if no suffix is |
| 661 | given, seconds are assumed. |
| 662 | .\"-opts |
| 663 | .RE |
| 664 | .SP |
| 665 | .B "PORT" |
| 666 | Emits an |
| 667 | .B INFO |
| 668 | line containing just the number of the UDP port used by the |
| 669 | .B tripe |
| 670 | server. If you've allowed your server to allocate a port dynamically, |
| 671 | this is how to find out which one it chose. |
| 672 | .SP |
| 673 | .B "RELOAD" |
| 674 | Instructs the server to recheck its keyring files. The server checks |
| 675 | these periodically anyway but it may be necessary to force a recheck, |
| 676 | for example after adding a new peer key. |
| 677 | .SP |
| 678 | .B "QUIT" |
| 679 | Instructs the server to exit immediately. A warning is sent. |
| 680 | .SP |
| 681 | .B "SERVINFO" |
| 682 | Returns information about the server, in the form of key-value pairs. |
| 683 | The following keys are used. |
| 684 | .RS |
| 685 | .TP |
| 686 | .B implementation |
| 687 | A keyword naming the implementation of the |
| 688 | .BR tripe (8) |
| 689 | server. The current implementation is called |
| 690 | .BR edgeware-tripe . |
| 691 | .TP |
| 692 | .B version |
| 693 | The server's version number, as reported by |
| 694 | .BR VERSION . |
| 695 | .TP |
| 696 | .B daemon |
| 697 | Either |
| 698 | .B t |
| 699 | or |
| 700 | .BR nil , |
| 701 | if the server has or hasn't (respectively) become a daemon. |
| 702 | .RE |
| 703 | .SP |
| 704 | .BI "SETIFNAME " peer " " new-name |
| 705 | Informs the server that the |
| 706 | .IR peer 's |
| 707 | tunnel-interface name has been changed to |
| 708 | .IR new-name . |
| 709 | This is useful if firewalling decisions are made based on interface |
| 710 | names: a setup script for a particular peer can change the name, and |
| 711 | then update the server's records so that they're accurate. |
| 712 | .SP |
| 713 | .BI "STATS " peer |
| 714 | Emits a number of |
| 715 | .B INFO |
| 716 | lines, each containing one or more statistics in the form |
| 717 | .IB name = value \fR. |
| 718 | The statistics-gathering is experimental and subject to change. |
| 719 | .SP |
| 720 | .BI "SVCCLAIM " service " " version |
| 721 | Attempts to claim the named |
| 722 | .IR service , |
| 723 | offering the given |
| 724 | .IR version . |
| 725 | The claim is successful if the service is currently unclaimed, or if |
| 726 | a version earlier than |
| 727 | .I version |
| 728 | is provided; otherwise the command fails with the error |
| 729 | .BR "service-exists" . |
| 730 | .SP |
| 731 | .BI "SVCENSURE " service " \fR[" version \fR] |
| 732 | Ensure that |
| 733 | .I service |
| 734 | is provided, and (if specified) to at least the given |
| 735 | .IR version . |
| 736 | An error is reported if these conditions are not met; otherwise the |
| 737 | command succeeds silently. |
| 738 | .SP |
| 739 | .BI "SVCFAIL " jobid " " tokens \fR... |
| 740 | Send a |
| 741 | .B FAIL |
| 742 | (or |
| 743 | .BR BGFAIL ) |
| 744 | response to the service job with the given |
| 745 | .IR jobid , |
| 746 | passing the |
| 747 | .I tokens |
| 748 | as the reason for failure. The job is closed. |
| 749 | .SP |
| 750 | .BI "SVCINFO " jobid " " tokens \fR... |
| 751 | Send an |
| 752 | .B INFO |
| 753 | (or |
| 754 | .BR BGINFO ) |
| 755 | response to the service job with the given |
| 756 | .IR jobid , |
| 757 | passing the |
| 758 | .I tokens |
| 759 | as the info message. The job remains open. |
| 760 | .SP |
| 761 | .B "SVCLIST" |
| 762 | Output a line of the form |
| 763 | .RS |
| 764 | .IP |
| 765 | .B INFO |
| 766 | .I service |
| 767 | .I version |
| 768 | .PP |
| 769 | for each service currently provided. |
| 770 | .RE |
| 771 | .SP |
| 772 | .BI "SVCOK " jobid |
| 773 | Send an |
| 774 | .B OK |
| 775 | (or |
| 776 | .BR BGINFO ) |
| 777 | response to the service job with the given |
| 778 | .IR jobid . |
| 779 | The job is closed. |
| 780 | .SP |
| 781 | .BI "SVCQUERY " service |
| 782 | Emits a number of |
| 783 | .B info |
| 784 | lines in key-value format, describing the named |
| 785 | .IR service. |
| 786 | The following keys are used. |
| 787 | .RS |
| 788 | .TP |
| 789 | .B name |
| 790 | The service's name. |
| 791 | .TP |
| 792 | .B version |
| 793 | The service's version string. |
| 794 | .RE |
| 795 | .SP |
| 796 | .BI "SVCRELEASE " service |
| 797 | Announce that the client no longer wishes to provide the named |
| 798 | .IR service . |
| 799 | .SP |
| 800 | .BI "SVCSUBMIT \fR[" options "\fR] " service " " command " " arguments \fR... |
| 801 | Submit a job to the provider of the given |
| 802 | .IR service , |
| 803 | passing it the named |
| 804 | .I command |
| 805 | and the given |
| 806 | .IR arguments . |
| 807 | The following options are accepted. |
| 808 | .RS |
| 809 | .\"+opts |
| 810 | .TP |
| 811 | .BI "\-background " tag |
| 812 | Run the command in the background, using the given |
| 813 | .IR tag . |
| 814 | .TP |
| 815 | .BI "\-version " version |
| 816 | Ensure that at least the given |
| 817 | .I version |
| 818 | of the service is available before submitting the job. |
| 819 | .RE |
| 820 | .\"-opts |
| 821 | .SP |
| 822 | .BR "TRACE " [\fIoptions\fP] |
| 823 | Selects trace outputs: see |
| 824 | .B "Trace lists" |
| 825 | above. Message types provided are: |
| 826 | .RS |
| 827 | .PP |
| 828 | Currently, the following tracing options are supported: |
| 829 | .TP |
| 830 | .B t |
| 831 | Tunnel events: reception of packets to be encrypted, and injection of |
| 832 | successfully-decrypted packets. |
| 833 | .TP |
| 834 | .B r |
| 835 | Peer management events: creation and destruction of peer attachments, |
| 836 | and arrival of messages. |
| 837 | .TP |
| 838 | .B a |
| 839 | Administration interface: acceptance of new connections, and handling of |
| 840 | the backgroud name-resolution required by the |
| 841 | .B ADD |
| 842 | command. |
| 843 | .TP |
| 844 | .B s |
| 845 | Handling of symmetric keysets: creation and expiry of keysets, and |
| 846 | encryption and decryption of messages. |
| 847 | .TP |
| 848 | .B x |
| 849 | Key exchange: reception, parsing and emission of key exchange messages. |
| 850 | .TP |
| 851 | .B m |
| 852 | Key management: loading keys and checking for file modifications. |
| 853 | .TP |
| 854 | .B l |
| 855 | Display information about challenge issuing and verification. |
| 856 | .TP |
| 857 | .B p |
| 858 | Display contents of packets sent and received by the tunnel and/or peer |
| 859 | modules. |
| 860 | .TP |
| 861 | .B c |
| 862 | Display inputs, outputs and intermediate results of cryptographic |
| 863 | operations. This includes plaintext and key material. Use with |
| 864 | caution. |
| 865 | .TP |
| 866 | .B A |
| 867 | All of the above. |
| 868 | .PP |
| 869 | Note that the |
| 870 | .B p |
| 871 | (packet contents) |
| 872 | and |
| 873 | .B c |
| 874 | (crypto details) |
| 875 | outputs provide extra detail for other outputs. Specifying |
| 876 | .B p |
| 877 | without |
| 878 | .BR r |
| 879 | or |
| 880 | .B t |
| 881 | isn't useful; neither is specifying |
| 882 | .B c |
| 883 | without one of |
| 884 | .BR s , |
| 885 | .BR l , |
| 886 | .B x |
| 887 | or |
| 888 | .BR m . |
| 889 | .RE |
| 890 | .SP |
| 891 | .B "TUNNELS" |
| 892 | For each available tunnel driver, an |
| 893 | .B INFO |
| 894 | line is printed giving its name. |
| 895 | .SP |
| 896 | .B "VERSION" |
| 897 | Causes the server to emit an |
| 898 | .B INFO |
| 899 | line stating its software version, as two tokens: the server name, and |
| 900 | its version string. The server name |
| 901 | .B tripe |
| 902 | is reserved to the Straylight/Edgeware implementation. |
| 903 | .SP |
| 904 | .BR "WATCH " [\fIoptions\fP] |
| 905 | Enables or disables asynchronous broadcasts |
| 906 | .IR "for the current connection only" . |
| 907 | See |
| 908 | .B "Trace lists" |
| 909 | above. The default watch state for the connection the server opens |
| 910 | automatically on stdin/stdout is to show warnings and trace messages; |
| 911 | other connections show no asynchronous broadcast messages. (This is |
| 912 | done in order to guarantee that a program reading the server's stdout |
| 913 | does not miss any warnings.) |
| 914 | .RS |
| 915 | .PP |
| 916 | Message types provided are: |
| 917 | .TP |
| 918 | .B t |
| 919 | .B TRACE |
| 920 | messages. |
| 921 | .TP |
| 922 | .B n |
| 923 | .B NOTE |
| 924 | messages. |
| 925 | .TP |
| 926 | .B w |
| 927 | .B WARN |
| 928 | messages. |
| 929 | .TP |
| 930 | .B A |
| 931 | All of the above. |
| 932 | .RE |
| 933 | .SP |
| 934 | .BI "WARN " tokens\fR... |
| 935 | Issues a |
| 936 | .B USER |
| 937 | warning to all interested administration clients. |
| 938 | . |
| 939 | .\"-------------------------------------------------------------------------- |
| 940 | .SH "ERROR MESSAGES" |
| 941 | . |
| 942 | .\"* 20 Error messages (FAIL codes) |
| 943 | The following |
| 944 | .B FAIL |
| 945 | (or |
| 946 | .BR BGFAIL ) |
| 947 | messages are sent to clients as a result of errors during command |
| 948 | processing. |
| 949 | .SP |
| 950 | .BI "already-daemon" |
| 951 | (For |
| 952 | .BR DAEMON .) |
| 953 | The |
| 954 | .B tripe |
| 955 | server is already running as a daemon. |
| 956 | .SP |
| 957 | .BI "bad-addr-syntax " message |
| 958 | (For commands accepting socket addresses.) The address couldn't be |
| 959 | understood. |
| 960 | .SP |
| 961 | .BI "bad-base64 " message |
| 962 | (For commands accepting Base64-encoded input.) The Base64-encoded |
| 963 | string was invalid. |
| 964 | .SP |
| 965 | .BI "bad-syntax " cmd " " message |
| 966 | (For any command.) The command couldn't be understood: e.g., the number |
| 967 | of arguments was wrong. |
| 968 | .SP |
| 969 | .BI "bad-time-spec " token |
| 970 | The |
| 971 | .I token |
| 972 | is not a valid time interval specification. Acceptable time |
| 973 | specifications are nonnegative integers followed optionally by |
| 974 | .BR d , |
| 975 | .BR h , |
| 976 | .BR m , |
| 977 | or |
| 978 | .BR s , |
| 979 | for days, hours, minutes, or seconds, respectively. |
| 980 | .SP |
| 981 | .BI "bad-trace-option " char |
| 982 | (For |
| 983 | .BR TRACE .) |
| 984 | An unknown trace option was requested. |
| 985 | .SP |
| 986 | .BI "bad-watch-option " char |
| 987 | (For |
| 988 | .BR WATCH .) |
| 989 | An unknown watch option was requested. |
| 990 | .SP |
| 991 | .BI "daemon-error " ecode " " message |
| 992 | (For |
| 993 | .BR DAEMON .) |
| 994 | An error occurred during the attempt to become a daemon, as reported by |
| 995 | .IR message . |
| 996 | .SP |
| 997 | .BI "invalid-port " number |
| 998 | (For |
| 999 | .BR ADD .) |
| 1000 | The given port number is out of range. |
| 1001 | .SP |
| 1002 | .BI "not-service-provider " service |
| 1003 | (For |
| 1004 | .BR SVCRELEASE .) |
| 1005 | The invoking client is not the current provider of the named |
| 1006 | .IR service , |
| 1007 | and is therefore not allowed to release it. |
| 1008 | .SP |
| 1009 | .BI "peer-create-fail " peer |
| 1010 | (For |
| 1011 | .BR ADD .) |
| 1012 | Adding |
| 1013 | .I peer |
| 1014 | failed for some reason. A warning should have been emitted explaining |
| 1015 | why. |
| 1016 | .SP |
| 1017 | .BI "peer-addr-exists " address\fR... |
| 1018 | (For |
| 1019 | .BR ADD .) |
| 1020 | There is already a peer with the given |
| 1021 | .IR address . |
| 1022 | .SP |
| 1023 | .BI "peer-exists " peer |
| 1024 | (For |
| 1025 | .BR ADD .) |
| 1026 | There is already a peer named |
| 1027 | .IR peer . |
| 1028 | .SP |
| 1029 | .B "ping-send-failed" |
| 1030 | The attempt to send a ping packet failed, probably due to lack of |
| 1031 | encryption keys. |
| 1032 | .SP |
| 1033 | .B "provider-failed" |
| 1034 | (For |
| 1035 | .BR SVCSUBMIT .) |
| 1036 | The service provider disconnected without sending back a final reply to |
| 1037 | the job. |
| 1038 | .SP |
| 1039 | .B "provider-overloaded" |
| 1040 | (For |
| 1041 | .BR SVCSUBMIT .) |
| 1042 | The service provider has too many jobs queued up for it already. |
| 1043 | .SP |
| 1044 | .BI "resolve-error " hostname |
| 1045 | (For |
| 1046 | .BR ADD .) |
| 1047 | The DNS name |
| 1048 | .I hostname |
| 1049 | could not be resolved. |
| 1050 | .SP |
| 1051 | .BI "resolver-timeout " hostname |
| 1052 | (For |
| 1053 | .BR ADD .) |
| 1054 | The DNS name |
| 1055 | .I hostname |
| 1056 | took too long to resolve. |
| 1057 | .SP |
| 1058 | .BI "service-exists " service " " version |
| 1059 | (For |
| 1060 | .BR SVCCLAIM .) |
| 1061 | Another client is already providing the stated |
| 1062 | .I version |
| 1063 | of the |
| 1064 | .IR service . |
| 1065 | .SP |
| 1066 | .BI "service-too-old " service " " version |
| 1067 | (For |
| 1068 | .B SVCENSURE |
| 1069 | and |
| 1070 | .BR SVCSUBMIT .) |
| 1071 | Only the given |
| 1072 | .I version |
| 1073 | of the requested |
| 1074 | .I service |
| 1075 | is available, which does not meet the stated requirements. |
| 1076 | .SP |
| 1077 | .BI "tag-exists " tag |
| 1078 | (For long-running commands.) The named |
| 1079 | .I tag |
| 1080 | is already the tag of an outstanding job. |
| 1081 | .SP |
| 1082 | .BI "unknown-command " token |
| 1083 | The command |
| 1084 | .I token |
| 1085 | was not recognized. |
| 1086 | .SP |
| 1087 | .BI "unknown-jobid " jobid |
| 1088 | (For |
| 1089 | .BR SVCOK , |
| 1090 | .BR SVCFAIL , |
| 1091 | and |
| 1092 | .BR SVCINFO .) |
| 1093 | The token |
| 1094 | .I jobid |
| 1095 | is not recognized as identifying an outstanding job. It may have just |
| 1096 | been cancelled. |
| 1097 | .SP |
| 1098 | .BI "unknown-peer " name |
| 1099 | (For |
| 1100 | .BR ADDR , |
| 1101 | .BR IFNAME , |
| 1102 | .BR KILL , |
| 1103 | .BR SETIFNAME , |
| 1104 | and |
| 1105 | .BR STATS .) |
| 1106 | There is no peer called |
| 1107 | .IR name . |
| 1108 | .SP |
| 1109 | .BI "unknown-port " port |
| 1110 | (For |
| 1111 | .BR ADD .) |
| 1112 | The port name |
| 1113 | .I port |
| 1114 | couldn't be found in |
| 1115 | .BR /etc/services . |
| 1116 | .SP |
| 1117 | .BI "unknown-service " service |
| 1118 | (For |
| 1119 | .BR SVCENSURE , |
| 1120 | .BR SVCQUERY , |
| 1121 | .BR SVCRELEASE , |
| 1122 | and |
| 1123 | .BR SVCSUBMIT .) |
| 1124 | The token |
| 1125 | .I service |
| 1126 | is not recognized as the name of a client-provided service. |
| 1127 | .SP |
| 1128 | .BI "unknown-tag " tag |
| 1129 | (For |
| 1130 | .BR BGCANCEL .) |
| 1131 | The given |
| 1132 | .I tag |
| 1133 | is not the tag for any outstanding background job. It may have just |
| 1134 | finished. |
| 1135 | .SP |
| 1136 | .BI "unknown-tunnel " tun |
| 1137 | (For |
| 1138 | .BR ADD .) |
| 1139 | The given |
| 1140 | .I tun |
| 1141 | is not the name of any known tunnel driver. |
| 1142 | . |
| 1143 | .\"-------------------------------------------------------------------------- |
| 1144 | .SH "NOTIFICATIONS" |
| 1145 | . |
| 1146 | .\"* 30 Notification broadcasts (NOTE codes) |
| 1147 | The following notifications are sent to clients who request them. |
| 1148 | .SP |
| 1149 | .BI "ADD " peer " " ifname " " address \fR... |
| 1150 | A new peer has been added. The peer's name is |
| 1151 | .IR peer , |
| 1152 | its tunnel is network interface |
| 1153 | .IR ifname , |
| 1154 | and its network address is |
| 1155 | .IR address . |
| 1156 | .SP |
| 1157 | .BI "DAEMON" |
| 1158 | The server has forked off into the sunset and become a daemon. |
| 1159 | .SP |
| 1160 | .BI "GREET " challenge " " address \fR... |
| 1161 | A valid greeting was received, with the given challenge (exactly as it |
| 1162 | was returned by |
| 1163 | .B GETCHAL |
| 1164 | earlier). |
| 1165 | .SP |
| 1166 | .BI "KILL " peer |
| 1167 | The peer |
| 1168 | .I peer |
| 1169 | has been killed. |
| 1170 | .SP |
| 1171 | .BI "KXDONE " peer |
| 1172 | Key exchange with |
| 1173 | .I peer |
| 1174 | finished successfully. |
| 1175 | .SP |
| 1176 | .BI "KXSTART " peer |
| 1177 | Key exchange with |
| 1178 | .I peer |
| 1179 | has begun or restarted. If key exchange keeps failing, this message |
| 1180 | will be repeated periodically. |
| 1181 | .SP |
| 1182 | .BI "NEWADDR " peer " " address |
| 1183 | The given mobile |
| 1184 | .IR peer 's |
| 1185 | IP address has been changed to |
| 1186 | .IR address . |
| 1187 | .SP |
| 1188 | .BI "NEWIFNAME " peer " " old-name " " new-name |
| 1189 | The given |
| 1190 | .IR peer 's |
| 1191 | tunnel interface name has been changed from |
| 1192 | .I old-name |
| 1193 | to |
| 1194 | .IR new-name , |
| 1195 | as a result of a |
| 1196 | .B SETIFNAME |
| 1197 | command. |
| 1198 | .SP |
| 1199 | .BI "SVCCLAIM " service " " version |
| 1200 | The named |
| 1201 | .I service |
| 1202 | is now available, at the stated |
| 1203 | .IR version . |
| 1204 | .SP |
| 1205 | .BI "SVCRELEASE " service |
| 1206 | The named |
| 1207 | .I service |
| 1208 | is no longer available. |
| 1209 | .SP |
| 1210 | .BI "USER " tokens\fR... |
| 1211 | An administration client issued a notification using the |
| 1212 | .B NOTIFY |
| 1213 | command. |
| 1214 | . |
| 1215 | .\"-------------------------------------------------------------------------- |
| 1216 | .SH "WARNINGS" |
| 1217 | . |
| 1218 | .\"* 40 Warning broadcasts (WARN codes) |
| 1219 | .\"+sep |
| 1220 | There are many possible warnings. They are categorized according to |
| 1221 | their first tokens. |
| 1222 | .PP |
| 1223 | Many of these warnings report system errors. These are reported as a |
| 1224 | pair of tokens, described below as |
| 1225 | .I ecode |
| 1226 | and |
| 1227 | .IR message . |
| 1228 | The |
| 1229 | .I ecode |
| 1230 | is a string of the form |
| 1231 | .BI E number |
| 1232 | giving the |
| 1233 | .BR errno (3) |
| 1234 | value of the error; the |
| 1235 | .I message |
| 1236 | is the `human-readable' form of the message, as reported by |
| 1237 | .BR strerror (3). |
| 1238 | .SS "ABORT warnings" |
| 1239 | These all indicate that the |
| 1240 | .B tripe |
| 1241 | server has become unable to continue. If enabled, the server will dump |
| 1242 | core in its configuration directory. |
| 1243 | .SP |
| 1244 | .BI "ABORT repeated-select-errors" |
| 1245 | The main event loop is repeatedly failing. If the server doesn't quit, |
| 1246 | it will probably waste all available CPU doing nothing. |
| 1247 | .SS "ADMIN warnings" |
| 1248 | These indicate a problem with the administration socket interface. |
| 1249 | .SP |
| 1250 | .BI "ADMIN accept-error " ecode " " message |
| 1251 | There was an error while attempting to accept a connection from a new |
| 1252 | client. |
| 1253 | .SP |
| 1254 | .BI "ADMIN client-write-error " ecode " " message |
| 1255 | There was an error sending data to a client. The connection to the |
| 1256 | client has been closed. |
| 1257 | .SS "CHAL warnings" |
| 1258 | These indicate errors in challenges, either in the |
| 1259 | .B CHECKCHAL |
| 1260 | command or in greeting packets. |
| 1261 | .SP |
| 1262 | .B "CHAL impossible-challenge" |
| 1263 | The server hasn't issued any challenges yet. Quite how anyone else |
| 1264 | thought he could make one up is hard to imagine. |
| 1265 | .SP |
| 1266 | .B "CHAL incorrect-tag" |
| 1267 | Challenge received contained the wrong authentication data. It might be |
| 1268 | very stale, or a forgery. |
| 1269 | .SP |
| 1270 | .B "CHAL invalid-challenge" |
| 1271 | Challenge received was the wrong length. We might have changed MAC |
| 1272 | algorithms since the challenge was issued, or it might just be rubbish. |
| 1273 | .SP |
| 1274 | .B "CHAL replay duplicated-sequence" |
| 1275 | Challenge received was a definite replay of an old challenge. Someone's |
| 1276 | up to something! |
| 1277 | .SP |
| 1278 | .B "CHAL replay old-sequence" |
| 1279 | Challenge received was old, but maybe not actually a replay. Try again. |
| 1280 | .SS "KEYMGMT warnings" |
| 1281 | These indicate a problem with the keyring files, or the keys stored in |
| 1282 | them. The first token is either |
| 1283 | .B private-keyring |
| 1284 | or |
| 1285 | .B public-keyring |
| 1286 | (notated |
| 1287 | .IB which -keyring |
| 1288 | in the descriptions below) indicating which keyring file is problematic, |
| 1289 | and the second token is the filename of the keyring. Frequently a key |
| 1290 | tag may be given next, preceded by the token |
| 1291 | .BR key . |
| 1292 | .SP |
| 1293 | .BI "KEYMGMT private-keyring " file " key " tag " incorrect-public-key" |
| 1294 | The private key doesn't record the correct corresponding public key. |
| 1295 | .SP |
| 1296 | .BI "KEYMGMT public-keyring " file " key " tag " algorithm-mismatch" |
| 1297 | A peer's public key doesn't request the same algorithms as our private |
| 1298 | key. |
| 1299 | .SP |
| 1300 | .BI "KEYMGMT " which "-keyring " file " key " tag " bad-tag-length " len |
| 1301 | The key attributes specify the length of MAC tag as |
| 1302 | .I len |
| 1303 | but this is an invalid value \(en either too large or not a multiple of |
| 1304 | eight. |
| 1305 | .SP |
| 1306 | .BI "KEYMGMT " which "-keyring " file " key " tag " bad-tag-length-string " str |
| 1307 | The key attributes contain |
| 1308 | .I str |
| 1309 | where a MAC tag length was expected. The key was generated wrongly. |
| 1310 | .SP |
| 1311 | .BI "KEYMGMT private-keyring " file " key " tag " changed-group" |
| 1312 | The private keyring has been changed, but the new private key can't be |
| 1313 | used because it uses a different group for Diffie\(enHellman key |
| 1314 | exchange. |
| 1315 | .SP |
| 1316 | .BI "KEYMGMT " which "-keyring " file " io-error " ecode " " message |
| 1317 | A system error occurred while opening or reading the keyring file. |
| 1318 | .SP |
| 1319 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-bulk-transform " bulk |
| 1320 | The key specifies the use of an unknown bulk-crypto transform |
| 1321 | .IR bulk . |
| 1322 | Maybe the key was generated wrongly, or maybe the version of Catacomb |
| 1323 | installed is too old. |
| 1324 | .SP |
| 1325 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-cipher " cipher |
| 1326 | The key specifies the use of an unknown symmetric encryption algorithm |
| 1327 | .IR cipher . |
| 1328 | Maybe the key was generated wrongly, or maybe the version of |
| 1329 | Catacomb installed is too old. |
| 1330 | .SP |
| 1331 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-group-type " type |
| 1332 | The key specifies the use of a Diffie\(enHellman group of an unknown |
| 1333 | .IR type . |
| 1334 | Maybe the key was generated wrongly, or maybe the version of |
| 1335 | .BR tripe (8) |
| 1336 | is too old. |
| 1337 | .SP |
| 1338 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-hash " hash |
| 1339 | The key specifies the use of an unknown hash function |
| 1340 | .IR hash . |
| 1341 | Maybe the key was generated wrongly, or maybe the version of Catacomb |
| 1342 | installed is too old. |
| 1343 | .SP |
| 1344 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-mac " mac |
| 1345 | The key specifies the use of an unknown message authentication code |
| 1346 | .IR mac . |
| 1347 | Maybe the key was generated wrongly, or maybe the version of Catacomb |
| 1348 | installed is too old. |
| 1349 | .SP |
| 1350 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-mgf-cipher " mgf |
| 1351 | The key specifies the use of an unknown symmetric encryption function |
| 1352 | .I mgf |
| 1353 | for mask generation. Maybe the key was generated wrongly, or maybe the |
| 1354 | version of Catacomb installed is too old. |
| 1355 | .SP |
| 1356 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-serialization-format " ser |
| 1357 | The key specifies the use of an unknown serialization format |
| 1358 | .I ser |
| 1359 | for hashing group elements. Maybe the key was generated wrongly, or |
| 1360 | maybe the version of Catacomb installed is too old. |
| 1361 | .SP |
| 1362 | .BI "KEYMGMT " which "-keyring " file " key " tag " no-hmac-for-hash " hash |
| 1363 | No message authentication code was given explicitly, and there's no |
| 1364 | implementation of HMAC for the selected hash function |
| 1365 | .IR hash . |
| 1366 | .SP |
| 1367 | .BI "KEYMGMT " which "-keyring " file " key " tag " " alg " " name " no-key-size " hashsz |
| 1368 | The |
| 1369 | .I alg |
| 1370 | token is either |
| 1371 | .B cipher |
| 1372 | or |
| 1373 | .BR mac . |
| 1374 | The named algorithm requires more key material than the hash function |
| 1375 | can provide. You must change either the hash function, or the cipher or |
| 1376 | MAC. |
| 1377 | .SP |
| 1378 | .BI "KEYMGMT " which "-keyring " file " key " tag " mgf " mgf " restrictive-key-schedule" |
| 1379 | The cipher selected for mask-generation is unsuitable because it can't |
| 1380 | accept arbitrary-sized keys. |
| 1381 | .SP |
| 1382 | .BI "KEYMGMT " which "-keyring " file " key-not-found " tag |
| 1383 | A key named |
| 1384 | .I tag |
| 1385 | couldn't be found in the keyring. |
| 1386 | .SP |
| 1387 | .BI "KEYMGMT " which "-keyring " file " line " line " " message |
| 1388 | The contents of the keyring file are invalid. There may well be a bug |
| 1389 | in the |
| 1390 | .BR key (1) |
| 1391 | program. |
| 1392 | .SS "KX warnings" |
| 1393 | These indicate problems during key-exchange. Many indicate either a bug |
| 1394 | in the server (either yours or the remote one), or some kind of attack |
| 1395 | in progress. All name a |
| 1396 | .I peer |
| 1397 | as the second token: this is the peer the packet is apparently from, |
| 1398 | though it may have been sent by an attacker instead. |
| 1399 | .PP |
| 1400 | In the descriptions below, |
| 1401 | .I msgtoken |
| 1402 | is one of the tokens |
| 1403 | .BR pre-challenge , |
| 1404 | .BR cookie , |
| 1405 | .BR challenge , |
| 1406 | .BR reply , |
| 1407 | .BR switch-rq , |
| 1408 | or |
| 1409 | .BR switch-ok . |
| 1410 | .SP |
| 1411 | .BI "KX " peer " algorithms-mismatch local-private-key " privtag " peer-public-key " pubtag |
| 1412 | The algorithms specified in the peer's public key |
| 1413 | .I pubtag |
| 1414 | don't match the ones described in the private key |
| 1415 | .IR privtag . |
| 1416 | .SP |
| 1417 | .BI "KX " peer " bad-expected-reply-log" |
| 1418 | The challenges |
| 1419 | .B tripe |
| 1420 | uses in its protocol contain a check value which proves that the |
| 1421 | challenge is honest. This message indicates that the check value |
| 1422 | supplied is wrong: someone is attempting to use bogus challenges to |
| 1423 | persuade your |
| 1424 | .B tripe |
| 1425 | server to leak private key information. No chance! |
| 1426 | .SP |
| 1427 | .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok" |
| 1428 | A symmetrically-encrypted portion of a key-exchange message failed to |
| 1429 | decrypt. |
| 1430 | .SP |
| 1431 | .BI "KX " peer " invalid " msgtoken |
| 1432 | A key-exchange message was malformed. This almost certainly indicates a |
| 1433 | bug somewhere. |
| 1434 | .SP |
| 1435 | .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok" |
| 1436 | A message didn't contain the right magic data. This may be a replay of |
| 1437 | some old exchange, or random packets being sent in an attempt to waste |
| 1438 | CPU. |
| 1439 | .SP |
| 1440 | .BI "KX " peer " " which "-key-expired" |
| 1441 | The local private key or the peer's public key (distinguished by |
| 1442 | .IR which ) |
| 1443 | has expired. Either you or the peer's maintainer should have arranged |
| 1444 | for a replacement before now. |
| 1445 | .SP |
| 1446 | .BI "KX " peer " sending-cookie" |
| 1447 | We've received too many bogus pre-challenge messages. Someone is trying |
| 1448 | to flood us with key-exchange messages and make us waste CPU on doing |
| 1449 | hard asymmetric crypto sums. |
| 1450 | .SP |
| 1451 | .BI "KX " peer " unexpected " msgtoken |
| 1452 | The message received wasn't appropriate for this stage of the key |
| 1453 | exchange process. This may mean that one of our previous packets got |
| 1454 | lost. For |
| 1455 | .BR pre-challenge , |
| 1456 | it may simply mean that the peer has recently restarted. |
| 1457 | .SP |
| 1458 | .BI "KX " peer " unknown-challenge" |
| 1459 | The peer is asking for an answer to a challenge which we don't know |
| 1460 | about. This may mean that we've been inundated with challenges from |
| 1461 | some malicious source |
| 1462 | .I who can read our messages |
| 1463 | and discarded the valid one. |
| 1464 | .SP |
| 1465 | .BI "KX " peer " unknown-message 0x" nn |
| 1466 | An unknown key-exchange message arrived. |
| 1467 | .SS "PEER warnings" |
| 1468 | These are largely concerned with management of peers and the low-level |
| 1469 | details of the network protocol. The second token is usually the name of |
| 1470 | a peer, or |
| 1471 | .RB ` \- ' |
| 1472 | if none is relevant. |
| 1473 | .SP |
| 1474 | .BI "PEER " peer " bad-packet no-type" |
| 1475 | An empty packet arrived. This is very strange. |
| 1476 | .SP |
| 1477 | .BI "PEER " peer " bad-packet unknown-category 0x" nn |
| 1478 | The message category |
| 1479 | .I nn |
| 1480 | (in hex) isn't understood. Probably a strange random packet from |
| 1481 | somewhere; could be an unlikely bug. |
| 1482 | .SP |
| 1483 | .BI "PEER " peer " bad-packet unknown-type 0x" nn |
| 1484 | The message type |
| 1485 | .I nn |
| 1486 | (in hex) isn't understood. Probably a strange random packet from |
| 1487 | somewhere; could be an unlikely bug. |
| 1488 | .SP |
| 1489 | .BI "PEER " peer " corrupt-encrypted-ping" |
| 1490 | The peer sent a ping response which matches an outstanding ping, but its |
| 1491 | payload is wrong. There's definitely a bug somewhere. |
| 1492 | .SP |
| 1493 | .BI "PEER " peer " corrupt-transport-ping" |
| 1494 | The peer (apparently) sent a ping response which matches an outstanding |
| 1495 | ping, but its payload is wrong. Either there's a bug, or the bad guys |
| 1496 | are playing tricks on you. |
| 1497 | .SP |
| 1498 | .BI "PEER " peer " decrypt-failed" |
| 1499 | An encrypted IP packet failed to decrypt. It may have been mangled in |
| 1500 | transit, or may be a very old packet from an expired previous session |
| 1501 | key. There is usually a considerable overlap in the validity periods of |
| 1502 | successive session keys, so this shouldn't occur unless the key exchange |
| 1503 | takes ages or fails. |
| 1504 | .SP |
| 1505 | .BI "PEER " peer " malformed-encrypted-ping" |
| 1506 | The peer sent a ping response which is hopelessly invalid. There's |
| 1507 | definitely a bug somewhere. |
| 1508 | .SP |
| 1509 | .BI "PEER " peer " malformed-transport-ping" |
| 1510 | The peer (apparently) sent a ping response which is hopelessly invalid. |
| 1511 | Either there's a bug, or the bad guys are playing tricks on you. |
| 1512 | .SP |
| 1513 | .BI "PEER " peer " packet-build-failed" |
| 1514 | There wasn't enough space in our buffer to put the packet we wanted to |
| 1515 | send. Shouldn't happen. |
| 1516 | .SP |
| 1517 | .BI "PEER \- socket-read-error " ecode " " message |
| 1518 | An error occurred trying to read an incoming packet. |
| 1519 | .SP |
| 1520 | .BI "PEER " peer " socket-write-error " ecode " " message |
| 1521 | An error occurred attempting to send a network packet. We lost that |
| 1522 | one. |
| 1523 | .SP |
| 1524 | .BI "PEER " peer " unexpected-encrypted-ping 0x" id |
| 1525 | The peer sent an encrypted ping response whose id doesn't match any |
| 1526 | outstanding ping. Maybe it was delayed for longer than the server was |
| 1527 | willing to wait, or maybe the peer has gone mad. |
| 1528 | .SP |
| 1529 | .BI "PEER \- unexpected-source " address\fR... |
| 1530 | A packet arrived from |
| 1531 | .I address |
| 1532 | (a network address \(en see above), but no peer is known at that |
| 1533 | address. This may indicate a misconfiguration, or simply be a result of |
| 1534 | one end of a connection being set up before the other. |
| 1535 | .SP |
| 1536 | .BI "PEER " peer " unexpected-transport-ping 0x" id |
| 1537 | The peer (apparently) sent a transport ping response whose id doesn't |
| 1538 | match any outstanding ping. Maybe it was delayed for longer than the |
| 1539 | server was willing to wait, or maybe the peer has gone mad; or maybe |
| 1540 | there are bad people trying to confuse you. |
| 1541 | .SS "PRIVSEP warnings" |
| 1542 | These indicate problems with the privilege-separation helper process. |
| 1543 | (The server tries to drop its privileges when it starts up, leaving a |
| 1544 | privileged helper process behind which will create and hand over tunnel |
| 1545 | descriptors on request, but hopefully not do anything else especially |
| 1546 | dangerous. Tunnel descriptors are not completely safe, but this is |
| 1547 | probably better than nothing.) |
| 1548 | .SP |
| 1549 | .BI "PRIVSEP child-exited " rc |
| 1550 | The helper process exited normally with status |
| 1551 | .IR rc . |
| 1552 | Status 0 means that it thought the server didn't want it any more; 1 |
| 1553 | means that it was invoked incorrectly; 127 means that some system call |
| 1554 | failed. |
| 1555 | .SP |
| 1556 | .BI "PRIVSEP child-killed " sig |
| 1557 | The helper process was killed by signal number |
| 1558 | .IR sig . |
| 1559 | .SP |
| 1560 | .BI "PRIVSEP child-died " status |
| 1561 | The helper process died in some unexpected way; |
| 1562 | .I status is the raw status code returned by |
| 1563 | .BR waitpid (2), |
| 1564 | because the server didn't understand how to decode it. |
| 1565 | .SP |
| 1566 | .BI "PRIVSEP helper-died" |
| 1567 | A tunnel driver requires a tunnel descriptor from the helper, but the |
| 1568 | helper isn't running so this won't work. |
| 1569 | .SP |
| 1570 | .BI "PRIVSEP helper-read-error " ecode " " message |
| 1571 | The server failed to read a response from the helper process. |
| 1572 | .SP |
| 1573 | .BI "PRIVSEP helper-short-read" |
| 1574 | The helper process didn't send back enough data, and has likely crashed. |
| 1575 | .SP |
| 1576 | .BI "PRIVSEP helper-write-error " ecode " " message |
| 1577 | The server failed to send a message to the helper process. |
| 1578 | .SP |
| 1579 | .BI "PRIVSEP no-fd-from-helper" |
| 1580 | The helper process sent back a positive response, but didn't include the |
| 1581 | requested tunnel descriptor. |
| 1582 | .SP |
| 1583 | .BI "PRIVSEP unknown-response-code" |
| 1584 | The helper process sent back an incomprehensible reply. It's probably |
| 1585 | very confused and may crash. |
| 1586 | .SS "SERVER warnings" |
| 1587 | These indicate problems concerning the server process as a whole. |
| 1588 | .SP |
| 1589 | .BI "SERVER ignore signal " name |
| 1590 | A signal arrived, but the server ignored it. Currently this happens for |
| 1591 | .B SIGHUP |
| 1592 | because that's a popular way of telling daemons to re-read their |
| 1593 | configuration files. Since |
| 1594 | .B tripe |
| 1595 | re-reads its keyrings automatically and has no other configuration |
| 1596 | files, it's not relevant, but it seemed better to ignore the signal than |
| 1597 | let the server die. |
| 1598 | .SP |
| 1599 | .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR] |
| 1600 | A signal arrived and |
| 1601 | .B tripe |
| 1602 | is going to quit. |
| 1603 | .SP |
| 1604 | .BI "SERVER quit admin-request" |
| 1605 | A client of the administration interface issued a |
| 1606 | .B QUIT |
| 1607 | command. |
| 1608 | .SP |
| 1609 | .BI "SERVER quit foreground-eof" |
| 1610 | The server is running in foreground mode (the |
| 1611 | .B \-F |
| 1612 | option), and encountered end-of-file on standard input. |
| 1613 | .SP |
| 1614 | .BI "SERVER select-error " ecode " " message |
| 1615 | An error occurred in the server's main event loop. This is bad: if it |
| 1616 | happens too many times, the server will abort. |
| 1617 | .SP |
| 1618 | .BI "SERVER waitpid-error " ecode " " message |
| 1619 | The server was informed that one of its child processes had exited, but |
| 1620 | couldn't retrieve the child's status. |
| 1621 | .SS "SYMM warnings" |
| 1622 | These are concerned with the symmetric encryption and decryption |
| 1623 | process. |
| 1624 | .SP |
| 1625 | .BI "SYMM replay old-sequence" |
| 1626 | A packet was received with an old sequence number. It may just have |
| 1627 | been delayed or duplicated, or it may have been an attempt at a replay |
| 1628 | attack. |
| 1629 | .SP |
| 1630 | .BI "SYMM replay duplicated-sequence" |
| 1631 | A packet was received with a sequence number we've definitely seen |
| 1632 | before. It may be an accidental duplication because the 'net is like |
| 1633 | that, or a deliberate attempt at a replay. |
| 1634 | .SS "TUN warnings" |
| 1635 | These concern the workings of the system-specific tunnel driver. The |
| 1636 | second token is the name of the tunnel interface in question, or |
| 1637 | .RB ` \- ' |
| 1638 | if none. |
| 1639 | .SP |
| 1640 | .BI "TUN \- bsd no-tunnel-devices" |
| 1641 | The driver couldn't find an available tunnel device. Maybe if you |
| 1642 | create some more |
| 1643 | .BI /dev/tun nn |
| 1644 | files, it will work. |
| 1645 | .SP |
| 1646 | .BI "TUN \- " tun-name " open-error " device " " ecode " " message |
| 1647 | An attempt to open the tunnel device file |
| 1648 | .I device |
| 1649 | failed. |
| 1650 | .SP |
| 1651 | .BI "TUN \- linux config-error " ecode " " message |
| 1652 | Configuring the Linux TUN/TAP interface failed. |
| 1653 | .SP |
| 1654 | .BI "TUN " ifname " " tun-name " read-error " ecode " " message |
| 1655 | Reading from the tunnel device failed. |
| 1656 | .SP |
| 1657 | .BI "TUN " ifname " " tun-name " write-error " ecode " " message |
| 1658 | Writing from the tunnel device failed. |
| 1659 | .SP |
| 1660 | .BI "TUN " ifname " slip bad-escape" |
| 1661 | The SLIP driver encountered a escaped byte it wasn't expecting to see. |
| 1662 | The erroneous packet will be ignored. |
| 1663 | .SP |
| 1664 | .BI "TUN " ifname " slip eof" |
| 1665 | The SLIP driver encountered end-of-file on its input descriptor. |
| 1666 | Pending data is discarded, and no attempt is made to read any more data |
| 1667 | from that interface ever. |
| 1668 | .SP |
| 1669 | .BI "TUN " ifname " slip escape-end" |
| 1670 | The SLIP driver encountered an escaped `end' marker. This probably |
| 1671 | means that someone's been sending it junk. The erroneous packet is |
| 1672 | discarded, and we hope that we've rediscovered synchronization. |
| 1673 | .SP |
| 1674 | .BI "TUN \- slip fork-error " ecode " " message |
| 1675 | The SLIP driver encountered an error forking a child process while |
| 1676 | allocating a new dynamic interface. |
| 1677 | .SP |
| 1678 | .BI "TUN \- slip no-slip-interfaces" |
| 1679 | The driver ran out of static SLIP interfaces. Either preallocate more, |
| 1680 | or use dynamic SLIP interface allocation. |
| 1681 | .SP |
| 1682 | .BI "TUN " ifname " slip overflow" |
| 1683 | The SLIP driver gave up reading a packet because it got too large. |
| 1684 | .SP |
| 1685 | .BI "TUN \- slip pipe-error " ecode " " message |
| 1686 | The SLIP driver encountered an error creating pipes while allocating a |
| 1687 | new dynamic interface. |
| 1688 | .SP |
| 1689 | .BI "TUN \- slip read-ifname-failed " ecode " " message |
| 1690 | The SLIP driver encountered an error reading the name of a dynamically |
| 1691 | allocated interface. Maybe the allocation script is broken. |
| 1692 | .SP |
| 1693 | .BI "TUN \- unet config-error " ecode " " message |
| 1694 | Configuring the Linux Unet interface failed. Unet is obsolete and |
| 1695 | shouldn't be used any more. |
| 1696 | .SP |
| 1697 | .BI "TUN \- unet getinfo-error " ecode " " message |
| 1698 | Reading information about the Unet interface failed. Unet is obsolete |
| 1699 | and shouldn't be used any more. |
| 1700 | .SS "USER warnings" |
| 1701 | These are issued by administration clients using the |
| 1702 | .B WARN |
| 1703 | command. |
| 1704 | .SP |
| 1705 | .BI "USER " tokens\fR... |
| 1706 | An administration client issued a warning. |
| 1707 | .\"-sep |
| 1708 | . |
| 1709 | .\"-------------------------------------------------------------------------- |
| 1710 | .SH "SUMMARY" |
| 1711 | . |
| 1712 | .SS "Command responses" |
| 1713 | .nf |
| 1714 | .BI "BGDETACH " tag |
| 1715 | .BI "BGFAIL " tag " " tokens \fR... |
| 1716 | .BI "BGINFO " tag " " tokens \fR... |
| 1717 | .BI "BGOK " tag |
| 1718 | .BI "FAIL " tokens \fR... |
| 1719 | .BI "INFO " tokens \fR... |
| 1720 | .B OK |
| 1721 | .fi |
| 1722 | .\"= summary |
| 1723 | . |
| 1724 | .\"-------------------------------------------------------------------------- |
| 1725 | .SH "SEE ALSO" |
| 1726 | . |
| 1727 | .BR tripectl (1), |
| 1728 | .BR tripe (8). |
| 1729 | .PP |
| 1730 | .IR "The Trivial IP Encryption Protocol" . |
| 1731 | . |
| 1732 | .\"-------------------------------------------------------------------------- |
| 1733 | .SH "AUTHOR" |
| 1734 | . |
| 1735 | Mark Wooding, <mdw@distorted.org.uk> |
| 1736 | . |
| 1737 | .\"----- That's all, folks -------------------------------------------------- |