| 1 | .\" -*-nroff-*- |
| 2 | .\" |
| 3 | .ie t \{\ |
| 4 | . if \n(.g \{\ |
| 5 | . fam P |
| 6 | . \} |
| 7 | .\} |
| 8 | . |
| 9 | .de SP |
| 10 | .TP |
| 11 | .. |
| 12 | .TH tripe-admin 5 "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" |
| 13 | .SH NAME |
| 14 | tripe-admin \- administrator commands for TrIPE |
| 15 | .SH DESCRIPTION |
| 16 | This manual page describes the administration interface provided by the |
| 17 | .BR tripe (8) |
| 18 | daemon. |
| 19 | .PP |
| 20 | The |
| 21 | .BR tripectl (8) |
| 22 | program can be used either interactively or in scripts to communicate |
| 23 | with the server using this interface. Alternatively, simple custom |
| 24 | clients can be written in scripting languages such as Perl, Python or |
| 25 | Tcl, or more advanced clients such as GUI monitors can be written in C |
| 26 | with little difficulty. |
| 27 | .PP |
| 28 | By default, the server listens for admin connections on the Unix-domain |
| 29 | socket |
| 30 | .BR /var/lib/tripe/tripesock . |
| 31 | Administration commands use a textual protocol. Each client command or |
| 32 | server response consists of a line of ASCII text terminated by a single |
| 33 | linefeed character. No command may be longer than 255 characters. |
| 34 | .SS "General structure" |
| 35 | Each command or response line consists of a sequence of |
| 36 | whitespace-separated words. The number and nature of whitespace |
| 37 | characters separating two words in a client command is not significant; |
| 38 | the server always uses a single space character. The first word in a |
| 39 | line is a |
| 40 | .I keyword |
| 41 | identifying the type of command or response contained. Keywords in |
| 42 | client commands are not case-sensitive; the server always uses uppercase |
| 43 | for its keywords. |
| 44 | .SS "Simple commands" |
| 45 | For simple client command, the server responds with zero or more |
| 46 | .B INFO |
| 47 | lines, followed by either an |
| 48 | .B OK |
| 49 | line or a |
| 50 | .B FAIL |
| 51 | line. Each |
| 52 | .B INFO |
| 53 | provides information requested in the command. An |
| 54 | .B OK |
| 55 | response contains no further data. A |
| 56 | .B FAIL |
| 57 | code is followed by a machine-readable explanation of why the command |
| 58 | failed. |
| 59 | .PP |
| 60 | Simple command processing is strictly synchronous: the server reads a |
| 61 | command, processes it, and responds, before reading the next command. |
| 62 | All commands can be run as simple commands. Long-running commands |
| 63 | (e.g., |
| 64 | .B ADD |
| 65 | and |
| 66 | .BR PING ) |
| 67 | block the client until they finish, but the rest of the server continues |
| 68 | running. |
| 69 | .SS "Asynchronous messages" |
| 70 | There are three types of asynchronous messages which |
| 71 | aren't associated with any particular command. |
| 72 | .PP |
| 73 | The |
| 74 | .B WARN |
| 75 | message contains a machine-readable message warning of an error |
| 76 | encountered while processing a command, unexpected or unusual behaviour |
| 77 | by a peer, or a possible attack by an adversary. Under normal |
| 78 | conditions, the server shouldn't emit any warnings. |
| 79 | .PP |
| 80 | The |
| 81 | .B TRACE |
| 82 | message contains a human-readable tracing message containing diagnostic |
| 83 | information. Trace messages are controlled using the |
| 84 | .B \-T |
| 85 | command-line option to the server, or the |
| 86 | .B TRACE |
| 87 | administration command (see below). Support for tracing can be disabled |
| 88 | when the package is being configured, and may not be available in your |
| 89 | version. |
| 90 | .PP |
| 91 | Finally, the |
| 92 | .B NOTE |
| 93 | message is a machine-readable notification about some routine but |
| 94 | interesting event such as creation or destruction of peers. |
| 95 | .PP |
| 96 | The presence of asynchronous messages can be controlled using the |
| 97 | .B WATCH |
| 98 | command. |
| 99 | .SS "Background commands" |
| 100 | Some commands (e.g., |
| 101 | .B ADD |
| 102 | and |
| 103 | .BR PING ) |
| 104 | take a long time to complete. To prevent these long-running commands |
| 105 | from tying up a server connection, they can be run in the background. |
| 106 | Not all commands can be run like this: the ones that can provide a |
| 107 | .B \-background |
| 108 | option, which must be supplied with a |
| 109 | .IR tag . |
| 110 | .PP |
| 111 | A command may fail before it starts running in the background. In this |
| 112 | case, the server emits a |
| 113 | .B FAIL |
| 114 | response, as usual. To indicate that a command has started running in |
| 115 | the background, the server emits a response of the form |
| 116 | .BI "BGDETACH " tag \fR, |
| 117 | where |
| 118 | .I tag |
| 119 | is the value passed to the |
| 120 | .B \-background |
| 121 | option. From this point on, the server is ready to process more |
| 122 | commands and reply to them. |
| 123 | .PP |
| 124 | Responses to background commands are indicated by a line beginning with |
| 125 | one of the tokens |
| 126 | .BR BGOK , |
| 127 | .BR BGFAIL , |
| 128 | or |
| 129 | .BR BGINFO , |
| 130 | followed by the command tag. These correspond to the |
| 131 | .BR OK , |
| 132 | .BR FAIL , |
| 133 | and |
| 134 | .B INFO |
| 135 | responses for simple commands: |
| 136 | .B BGINFO |
| 137 | indicates information from a background command which has not completed |
| 138 | yet; and |
| 139 | .B BGOK |
| 140 | and |
| 141 | .B BGFAIL |
| 142 | indicates that a background command succeeded or failed, respectively. |
| 143 | .PP |
| 144 | A background command will never issue an |
| 145 | .B OK |
| 146 | or |
| 147 | .B BGINFO |
| 148 | response: it will always detach and then issue any |
| 149 | .B BGINFO |
| 150 | lines followed by |
| 151 | .B BGOK |
| 152 | response. |
| 153 | .SS "Network addresses" |
| 154 | A network address is a sequence of words. The first is a token |
| 155 | identifying the network address family. The length of an address and |
| 156 | the meanings of the subsequent words depend on the address family. |
| 157 | Address family tokens are not case-sensitive on input; on output, they |
| 158 | are always in upper-case. |
| 159 | .PP |
| 160 | At present, only one address family is understood. |
| 161 | .TP |
| 162 | .BI "INET " address " " port |
| 163 | An Internet socket, naming an IPv4 address and UDP port. On output, the |
| 164 | address is always in numeric dotted-quad form, and the port is given as |
| 165 | a plain number. On input, DNS hostnames and symbolic port names are |
| 166 | permitted. Name resolution does not block the main server, but will |
| 167 | block the requesting client. This hopefully makes life simpler for |
| 168 | stupid clients. Complex clients which don't wish to be held up can open |
| 169 | extra connections or do the resolution themselves.) |
| 170 | .PP |
| 171 | If, on input, no recognised address family token is found, the following |
| 172 | words are assumed to represent an |
| 173 | .B INET |
| 174 | address. |
| 175 | .SS "Key-value output" |
| 176 | Some commands (e.g., |
| 177 | .B STATS |
| 178 | and |
| 179 | .BR SERVINFO ) |
| 180 | produce output in the form of |
| 181 | .IB key = value |
| 182 | pairs, one per word. Neither the |
| 183 | .I key |
| 184 | nor the |
| 185 | .I value |
| 186 | contain spaces. |
| 187 | .SS "Trace lists" |
| 188 | Commands which enable or disable kinds of output (e.g., |
| 189 | .B TRACE |
| 190 | and |
| 191 | .BR WATCH ) |
| 192 | work in similar ways. They take a single optional argument, which |
| 193 | consists of a string of letters selecting message types, optionally |
| 194 | interspersed with |
| 195 | .RB ` + ' |
| 196 | to enable, or |
| 197 | .RB ` \- ' |
| 198 | to disable, the subsequently listed types. |
| 199 | .PP |
| 200 | If the argument is omitted, the available message types are displayed, |
| 201 | one to an |
| 202 | .B INFO |
| 203 | line, in a fixed-column format. Column zero contains the key letter for |
| 204 | selecting that message type; column one contains either a space or a |
| 205 | .RB ` + ' |
| 206 | sign, if the message type is disabled or enabled respectively; and a |
| 207 | textual description of the message type begins at column 3 and continues |
| 208 | to the end of the line. |
| 209 | .PP |
| 210 | Lowercase key letters control individual message types. Uppercase key |
| 211 | letters control collections of message types. |
| 212 | .SH "COMMAND REFERENCE" |
| 213 | .\"* 10 Commands |
| 214 | The commands provided are: |
| 215 | .SP |
| 216 | .BI "ADD " peer " \fR[" options "\fR] " address "\fR..." |
| 217 | Adds a new peer. The peer is given the name |
| 218 | .IR peer ; |
| 219 | the peer's public key is assumed to be in the file |
| 220 | .B keyring.pub |
| 221 | (or whatever alternative file was specified in the |
| 222 | .B \-K |
| 223 | option on the command line). The |
| 224 | .I address |
| 225 | is the network address (see above for the format) at which the peer can |
| 226 | be contacted. The following options are recognised. |
| 227 | .RS |
| 228 | .\"+opts |
| 229 | .TP |
| 230 | .BI "\-background " tag |
| 231 | Run the command in the background, using the given |
| 232 | .IR tag . |
| 233 | .TP |
| 234 | .BI "\-keepalive " time |
| 235 | Send a no-op packet if we've not sent a packet to the peer in the last |
| 236 | .I time |
| 237 | interval. This is useful for persuading port-translating firewalls to |
| 238 | believe that the `connection' is still active. The |
| 239 | .I time |
| 240 | is expressed as a nonnegative integer followed optionally by |
| 241 | .BR d , |
| 242 | .BR h , |
| 243 | .BR m , |
| 244 | or |
| 245 | .BR s |
| 246 | for days, hours, minutes, or seconds respectively; if no suffix is |
| 247 | given, seconds are assumed. |
| 248 | .TP |
| 249 | .BI "\-tunnel " tunnel |
| 250 | Use the named tunnel driver, rather than the default. |
| 251 | .\"-opts |
| 252 | .RE |
| 253 | .SP |
| 254 | .BI "ADDR " peer |
| 255 | Emits an |
| 256 | .B INFO |
| 257 | line reporting the IP address and port number stored for |
| 258 | .IR peer . |
| 259 | .SP |
| 260 | .BI "CHECKCHAL " challenge |
| 261 | Verifies a challenge as being one earlier issued by |
| 262 | .B GETCHAL |
| 263 | and not previously either passed to |
| 264 | .B CHECKCHAL |
| 265 | or in a greeting message. |
| 266 | .SP |
| 267 | .B "DAEMON" |
| 268 | Causes the server to disassociate itself from its terminal and become a |
| 269 | background task. This only works once. A warning is issued. |
| 270 | .TP |
| 271 | .BI "EPING \fR[" options "\fR] " peer |
| 272 | Sends an encrypted ping to the peer, and expects an encrypted response. |
| 273 | This checks that the peer is running (and not being impersonated), and |
| 274 | that it can encrypt and decrypt packets correctly. Options and |
| 275 | responses are the same as for the |
| 276 | .B PING |
| 277 | command. |
| 278 | .SP |
| 279 | .BI "FORCEKX " peer |
| 280 | Requests the server to begin a new key exchange with |
| 281 | .I peer |
| 282 | immediately. |
| 283 | .SP |
| 284 | .B "GETCHAL" |
| 285 | Requests a challenge. The challenge is returned in an |
| 286 | .B INFO |
| 287 | line, as a base64-encoded string. See |
| 288 | .BR CHECKCHAL . |
| 289 | .SP |
| 290 | .BI "GREET " peer " " challenge |
| 291 | Sends a greeting packet containing the |
| 292 | .I challenge |
| 293 | (base-64 encoded) to the named |
| 294 | .IR peer . |
| 295 | The expectation is that this will cause the peer to recognize us and |
| 296 | begin a key-exchange. |
| 297 | .SP |
| 298 | .B "HELP" |
| 299 | Causes the server to emit an |
| 300 | .B INFO |
| 301 | line for each command it supports. Each line lists the command name, |
| 302 | followed by the names of the arguments. This may be helpful as a memory |
| 303 | aid for interactive use, or for program clients probing for features. |
| 304 | .SP |
| 305 | .BI "IFNAME " peer |
| 306 | Emits an |
| 307 | .B INFO |
| 308 | line containing the name of the network interface used to collect IP |
| 309 | packets which are to be encrypted and sent to |
| 310 | .IR peer . |
| 311 | Used by configuration scripts so that they can set up routing tables |
| 312 | appropriately after adding new peers. |
| 313 | .SP |
| 314 | .BI "KILL " peer |
| 315 | Causes the server to forget all about |
| 316 | .IR peer . |
| 317 | All keys are destroyed, and no more packets are sent. No notification |
| 318 | is sent to the peer: if it's important that the peer be notified, you |
| 319 | must think of a way to do that yourself. |
| 320 | .SP |
| 321 | .B "LIST" |
| 322 | For each currently-known peer, an |
| 323 | .B INFO |
| 324 | line is written containing the peer's name, as given to |
| 325 | .BR ADD . |
| 326 | .SP |
| 327 | .BI "NOTIFY " tokens\fR... |
| 328 | Issues a |
| 329 | .B USER |
| 330 | notification to all interested administration clients. |
| 331 | .SP |
| 332 | .BI "PEERINFO " peer |
| 333 | Returns information about a peer, in key-value form. The following keys |
| 334 | are returned. |
| 335 | .RS |
| 336 | .TP |
| 337 | .B tunnel |
| 338 | The tunnel driver used for this peer. |
| 339 | .TP |
| 340 | .B keepalive |
| 341 | The keepalive interval, in seconds, or zero if no keepalives are to be |
| 342 | sent. |
| 343 | .RE |
| 344 | .SP |
| 345 | .BI "PING \fR[" options "\fR] " peer |
| 346 | Send a transport-level ping to the peer. The ping and its response are |
| 347 | not encrypted or authenticated. This command, possibly in conjunction |
| 348 | with tracing, is useful for ensuring that UDP packets are actually |
| 349 | flowing in both directions. See also the |
| 350 | .B EPING |
| 351 | command. |
| 352 | .IP |
| 353 | An |
| 354 | .B INFO |
| 355 | line is printed describing the outcome: |
| 356 | .RS |
| 357 | .TP |
| 358 | .BI "ping-ok " millis |
| 359 | A response was received |
| 360 | .I millis |
| 361 | after the ping was sent. |
| 362 | .TP |
| 363 | .BI "ping-timeout" |
| 364 | No response was received within the time allowed. |
| 365 | .TP |
| 366 | .BI "ping-peer-died" |
| 367 | The peer was killed (probably by another admin connection) before a |
| 368 | response was received. |
| 369 | .RE |
| 370 | .IP |
| 371 | Options recognized for this command are: |
| 372 | .RS |
| 373 | .\"+opts |
| 374 | .TP |
| 375 | .BI "\-background " tag |
| 376 | Run the command in the background, using the given |
| 377 | .IR tag . |
| 378 | .TP |
| 379 | .BI "\-timeout " time |
| 380 | Wait for |
| 381 | .I time |
| 382 | seconds before giving up on a response. The default is 5 seconds. (The |
| 383 | time format is the same as for the |
| 384 | .B "ADD \-keepalive" |
| 385 | option.) |
| 386 | .\"-opts |
| 387 | .RE |
| 388 | .SP |
| 389 | .B "PORT" |
| 390 | Emits an |
| 391 | .B INFO |
| 392 | line containing just the number of the UDP port used by the |
| 393 | .B tripe |
| 394 | server. If you've allowed your server to allocate a port dynamically, |
| 395 | this is how to find out which one it chose. |
| 396 | .SP |
| 397 | .B "RELOAD" |
| 398 | Instructs the server to recheck its keyring files. The server checks |
| 399 | these periodically anyway but it may be necessary to force a recheck, |
| 400 | for example after adding a new peer key. |
| 401 | .SP |
| 402 | .B "QUIT" |
| 403 | Instructs the server to exit immediately. A warning is sent. |
| 404 | .SP |
| 405 | .B "SERVINFO" |
| 406 | Returns information about the server, in the form of key-value pairs. |
| 407 | The following keys are used. |
| 408 | .RS |
| 409 | .TP |
| 410 | .B implementation |
| 411 | A keyword naming the implementation of the |
| 412 | .BR tripe (8) |
| 413 | server. The current implementation is called |
| 414 | .BR edgeware-tripe . |
| 415 | .TP |
| 416 | .B version |
| 417 | The server's version number, as reported by |
| 418 | .BR VERSION . |
| 419 | .TP |
| 420 | .B daemon |
| 421 | Either |
| 422 | .B t |
| 423 | or |
| 424 | .BR nil , |
| 425 | if the server has or hasn't (respectively) become a daemon. |
| 426 | .RE |
| 427 | .SP |
| 428 | .BI "STATS " peer |
| 429 | Emits a number of |
| 430 | .B INFO |
| 431 | lines, each containing one or more statistics in the form |
| 432 | .IB name = value \fR. |
| 433 | The statistics-gathering is experimental and subject to change. |
| 434 | .SP |
| 435 | .BR "TRACE " [\fIoptions\fP] |
| 436 | Selects trace outputs: see |
| 437 | .B "Trace lists" |
| 438 | above. Message types provided are: |
| 439 | .RS |
| 440 | .PP |
| 441 | Currently, the following tracing options are supported: |
| 442 | .TP |
| 443 | .B t |
| 444 | Tunnel events: reception of packets to be encrypted, and injection of |
| 445 | successfully-decrypted packets. |
| 446 | .TP |
| 447 | .B r |
| 448 | Peer management events: creation and destruction of peer attachments, |
| 449 | and arrival of messages. |
| 450 | .TP |
| 451 | .B a |
| 452 | Administration interface: acceptance of new connections, and handling of |
| 453 | the backgroud name-resolution required by the |
| 454 | .B ADD |
| 455 | command. |
| 456 | .TP |
| 457 | .B s |
| 458 | Handling of symmetric keysets: creation and expiry of keysets, and |
| 459 | encryption and decryption of messages. |
| 460 | .TP |
| 461 | .B x |
| 462 | Key exchange: reception, parsing and emission of key exchange messages. |
| 463 | .TP |
| 464 | .B m |
| 465 | Key management: loading keys and checking for file modifications. |
| 466 | .TP |
| 467 | .B l |
| 468 | Display information about challenge issuing and verification. |
| 469 | .TP |
| 470 | .B p |
| 471 | Display contents of packets sent and received by the tunnel and/or peer |
| 472 | modules. |
| 473 | .TP |
| 474 | .B c |
| 475 | Display inputs, outputs and intermediate results of cryptographic |
| 476 | operations. This includes plaintext and key material. Use with |
| 477 | caution. |
| 478 | .TP |
| 479 | .B A |
| 480 | All of the above. |
| 481 | .PP |
| 482 | Note that the |
| 483 | .B p |
| 484 | (packet contents) |
| 485 | and |
| 486 | .B c |
| 487 | (crypto details) |
| 488 | outputs provide extra detail for other outputs. Specifying |
| 489 | .B p |
| 490 | without |
| 491 | .BR r |
| 492 | or |
| 493 | .B t |
| 494 | isn't useful; neither is specifying |
| 495 | .B c |
| 496 | without one of |
| 497 | .BR s , |
| 498 | .BR l , |
| 499 | .B x |
| 500 | or |
| 501 | .BR m . |
| 502 | .RE |
| 503 | .SP |
| 504 | .B "TUNNELS" |
| 505 | For each available tunnel driver, an |
| 506 | .B INFO |
| 507 | line is printed giving its name. |
| 508 | .SP |
| 509 | .B "VERSION" |
| 510 | Causes the server to emit an |
| 511 | .B INFO |
| 512 | line stating its software version, as two words: the server name, and |
| 513 | its version string. The server name |
| 514 | .B tripe |
| 515 | is reserved to the Straylight/Edgeware implementation. |
| 516 | .SP |
| 517 | .BR "WATCH " [\fIoptions\fP] |
| 518 | Enables or disables asynchronous messages |
| 519 | .IR "for the current connection only" . |
| 520 | See |
| 521 | .B "Trace lists" |
| 522 | above. The default watch state for the connection the server opens |
| 523 | automatically on stdin/stdout is to show warnings and trace messages; |
| 524 | other connections show no asynchronous messages. (This is done in order |
| 525 | to guarantee that a program reading the server's stdout does not miss |
| 526 | any warnings.) |
| 527 | .RS |
| 528 | .PP |
| 529 | Message types provided are: |
| 530 | .TP |
| 531 | .B t |
| 532 | .B TRACE |
| 533 | messages. |
| 534 | .TP |
| 535 | .B n |
| 536 | .B NOTE |
| 537 | messages. |
| 538 | .TP |
| 539 | .B w |
| 540 | .B WARN |
| 541 | messages. |
| 542 | .TP |
| 543 | .B A |
| 544 | All of the above. |
| 545 | .RE |
| 546 | .SP |
| 547 | .BI "WARN " tokens\fR... |
| 548 | Issues a |
| 549 | .B USER |
| 550 | warning to all interested administration clients. |
| 551 | .SH "ERROR MESSAGES" |
| 552 | .\"* 20 Error messages (FAIL codes) |
| 553 | The following |
| 554 | .B FAIL |
| 555 | (or |
| 556 | .BR BGFAIL ) |
| 557 | messages are sent to clients as a result of errors during command |
| 558 | processing. |
| 559 | .SP |
| 560 | .BI "already-daemon" |
| 561 | (For |
| 562 | .BR DAEMON .) |
| 563 | The |
| 564 | .B tripe |
| 565 | server is already running as a daemon. |
| 566 | .SP |
| 567 | .BI "bad-addr-syntax " message |
| 568 | (For commands accepting socket addresses.) The address couldn't be |
| 569 | understood. |
| 570 | .SP |
| 571 | .BI "bad-syntax " cmd " " message |
| 572 | (For any command.) The command couldn't be understood: e.g., the number |
| 573 | of arguments was wrong. |
| 574 | .SP |
| 575 | .BI "bad-time-spec " word |
| 576 | The |
| 577 | .I word |
| 578 | is not a valid time interval specification. Acceptable time |
| 579 | specifications are nonnegative integers followed optionally by |
| 580 | .BR d , |
| 581 | .BR h , |
| 582 | .BR m , |
| 583 | or |
| 584 | .BR s , |
| 585 | for days, hours, minutes, or seconds, respectively. |
| 586 | .SP |
| 587 | .BI "bad-trace-option " char |
| 588 | (For |
| 589 | .BR TRACE .) |
| 590 | An unknown trace option was requested. |
| 591 | .SP |
| 592 | .BI "bad-watch-option " char |
| 593 | (For |
| 594 | .BR WATCH .) |
| 595 | An unknown watch option was requested. |
| 596 | .SP |
| 597 | .BI "daemon-error " ecode " " message |
| 598 | (For |
| 599 | .BR DAEMON .) |
| 600 | An error occurred during the attempt to become a daemon, as reported by |
| 601 | .IR message . |
| 602 | .SP |
| 603 | .BI "invalid-port " number |
| 604 | (For |
| 605 | .BR ADD .) |
| 606 | The given port number is out of range. |
| 607 | .SP |
| 608 | .BI "peer-create-fail " peer |
| 609 | (For |
| 610 | .BR ADD .) |
| 611 | Adding |
| 612 | .I peer |
| 613 | failed for some reason. A warning should have been emitted explaining |
| 614 | why. |
| 615 | .SP |
| 616 | .BI "peer-exists " peer |
| 617 | (For |
| 618 | .BR ADD .) |
| 619 | There is already a peer named |
| 620 | .IR peer . |
| 621 | .SP |
| 622 | .B "ping-send-failed" |
| 623 | The attempt to send a ping packet failed, probably due to lack of |
| 624 | encryption keys. |
| 625 | .SP |
| 626 | .BI "resolve-error " hostname |
| 627 | (For |
| 628 | .BR ADD .) |
| 629 | The DNS name |
| 630 | .I hostname |
| 631 | could not be resolved. |
| 632 | .SP |
| 633 | .BI "resolver-timeout " hostname |
| 634 | (For |
| 635 | .BR ADD .) |
| 636 | The DNS name |
| 637 | .I hostname |
| 638 | took too long to resolve. |
| 639 | .SP |
| 640 | .BI "unknown-command " token |
| 641 | The command |
| 642 | .B token |
| 643 | was not recognised. |
| 644 | .SP |
| 645 | .BI "unknown-peer " name |
| 646 | (For |
| 647 | .BR ADDR , |
| 648 | .BR IFNAME , |
| 649 | .BR KILL , |
| 650 | and |
| 651 | .BR STATS .) |
| 652 | There is no peer called |
| 653 | .IR name . |
| 654 | .SP |
| 655 | .BI "unknown-service " service |
| 656 | (For |
| 657 | .BR ADD .) |
| 658 | The service name |
| 659 | .I service |
| 660 | couldn't be found in |
| 661 | .BR /etc/services . |
| 662 | .SH "NOTIFICATIONS" |
| 663 | .\"* 30 Notification broadcasts (NOTE codes) |
| 664 | The following notifications are sent to clients who request them. |
| 665 | .SP |
| 666 | .BI "ADD " peer " " ifname " " address \fR... |
| 667 | A new peer has been added. The peer's name is |
| 668 | .IR peer , |
| 669 | its tunnel is network interface |
| 670 | .IR ifname , |
| 671 | and its network address is |
| 672 | .IR address . |
| 673 | .SP |
| 674 | .BI "DAEMON" |
| 675 | The server has forked off into the sunset and become a daemon. |
| 676 | .SP |
| 677 | .BI "GREET " challenge " " address \fR... |
| 678 | A valid greeting was received, with the given challenge (exactly as it |
| 679 | was returned by |
| 680 | .B GETCHAL |
| 681 | earlier). |
| 682 | .SP |
| 683 | .BI "KILL " peer |
| 684 | The peer |
| 685 | .I peer |
| 686 | has been killed. |
| 687 | .SP |
| 688 | .BI "KXDONE " peer |
| 689 | Key exchange with |
| 690 | .I peer |
| 691 | finished successfully. |
| 692 | .SP |
| 693 | .BI "KXSTART " peer |
| 694 | Key exchange with |
| 695 | .I peer |
| 696 | has begun or restarted. If key exchange keeps failing, this message |
| 697 | will be repeated periodically. |
| 698 | .SP |
| 699 | .BI "USER " tokens\fR... |
| 700 | An administration client issued a notification using the |
| 701 | .B NOTIFY |
| 702 | command. |
| 703 | .SH "WARNINGS" |
| 704 | .\"* 40 Warning broadcasts (WARN codes) |
| 705 | .\"+sep |
| 706 | There are many possible warnings. They are categorized according to |
| 707 | their first tokens. |
| 708 | .PP |
| 709 | Many of these warnings report system errors. These are reported as a |
| 710 | pair of tokens, described below as |
| 711 | .I ecode |
| 712 | and |
| 713 | .IR message . |
| 714 | The |
| 715 | .I ecode |
| 716 | is a string of the form |
| 717 | .BI E number |
| 718 | giving the |
| 719 | .BR errno (3) |
| 720 | value of the error; the |
| 721 | .I message |
| 722 | is the `human-readable' form of the message, as reported by |
| 723 | .BR strerror (3). |
| 724 | .SS "ABORT warnings" |
| 725 | These all indicate that the |
| 726 | .B tripe |
| 727 | server has become unable to continue. If enabled, the server will dump |
| 728 | core in its configuration directory. |
| 729 | .SP |
| 730 | .BI "ABORT repeated-select-errors" |
| 731 | The main event loop is repeatedly failing. If the server doesn't quit, |
| 732 | it will probably waste all available CPU doing nothing. |
| 733 | .SS "ADMIN warnings" |
| 734 | These indicate a problem with the administration socket interface. |
| 735 | .SP |
| 736 | .BI "ADMIN accept-error " ecode " " message |
| 737 | There was an error while attempting to accept a connection from a new |
| 738 | client. |
| 739 | .SP |
| 740 | .BI "ADMIN client-write-error " ecode " " message |
| 741 | There was an error sending data to a client. The connection to the |
| 742 | client has been closed. |
| 743 | .SS "CHAL warnings" |
| 744 | These indicate errors in challenges, either in the |
| 745 | .B CHECKCHAL |
| 746 | command or in greeting packets. |
| 747 | .SP |
| 748 | .B "CHAL impossible-challenge" |
| 749 | The server hasn't issued any challenges yet. Quite how anyone else |
| 750 | thought he could make one up is hard to imagine. |
| 751 | .SP |
| 752 | .B "CHAL incorrect-tag" |
| 753 | Challenge received contained the wrong authentication data. It might be |
| 754 | very stale, or a forgery. |
| 755 | .SP |
| 756 | .B "CHAL invalid-challenge" |
| 757 | Challenge received was the wrong length. We might have changed MAC |
| 758 | algorithms since the challenge was issued, or it might just be rubbish. |
| 759 | .SP |
| 760 | .B "CHAL replay duplicated-sequence" |
| 761 | Challenge received was a definite replay of an old challenge. Someone's |
| 762 | up to something! |
| 763 | .SP |
| 764 | .B "CHAL replay old-sequence" |
| 765 | Challenge received was old, but maybe not actually a replay. Try again. |
| 766 | .SS "KEYMGMT warnings" |
| 767 | These indicate a problem with the keyring files, or the keys stored in |
| 768 | them. |
| 769 | .SP |
| 770 | .BI "KEYMGMT bad-private-key " message |
| 771 | The private key could not be read, or failed a consistency check. If |
| 772 | there was a problem with the file, usually there will have been |
| 773 | .B key-file-error |
| 774 | warnings before this. |
| 775 | .SP |
| 776 | .BI "KEYMGMT bad-public-keyring " message |
| 777 | The public keyring couldn't be read. Usually, there will have been |
| 778 | .B key-file-error |
| 779 | warnings before this. |
| 780 | .SP |
| 781 | .BI "KEYMGMT key-file-error " file ":" line " " message |
| 782 | Reports a specific error with the named keyring file. This probably |
| 783 | indicates a bug in |
| 784 | .BR key (1). |
| 785 | .SP |
| 786 | .BI "KEYMGMT public-key " tag " " tokens\fR... |
| 787 | These messages all indicate a problem with the public key named |
| 788 | .IR tag . |
| 789 | .SP |
| 790 | .BI "KEYMGMT public-key " tag " algorithm-mismatch" |
| 791 | The algorithms specified on the public key don't match the ones for our |
| 792 | private key. All the peers in a network have to use the same |
| 793 | algorithms. |
| 794 | .SP |
| 795 | .BI "KEYMGMT public-key " tag " bad " message |
| 796 | The public key couldn't be read, or is invalid. |
| 797 | .SP |
| 798 | .BI "KEYMGMT public-key " tag " bad-public-group-element" |
| 799 | The public key is invalid. This may indicate a malicious attempt to |
| 800 | introduce a bogus key. |
| 801 | .SP |
| 802 | .BI "KEYMGMT public-key " tag " bad-algorithm-selection" |
| 803 | The algorithms listed on the public key couldn't be understood. The |
| 804 | algorithm selection attributes are probably malformed and need fixing. |
| 805 | .SP |
| 806 | .BI "KEYMGMT public-key " tag " incorrect-group" |
| 807 | The public key doesn't use the same group as our private key. All the |
| 808 | peers in a network have to use the same group. |
| 809 | .SP |
| 810 | .BI "KEYMGMT public-key " tag " not-found" |
| 811 | The public key for peer |
| 812 | .I tag |
| 813 | wasn't in the public keyring. |
| 814 | .SP |
| 815 | .BI "KEYMGMT public-key " tag " unknown-type" |
| 816 | The type of the public key isn't understood. Maybe you need to upgrade |
| 817 | your copy of |
| 818 | .BR tripe . |
| 819 | (Even if you do, you'll have to regenerate your keys.) |
| 820 | .SS "KX warnings" |
| 821 | These indicate problems during key-exchange. Many indicate either a bug |
| 822 | in the server (either yours or the remote one), or some kind of attack |
| 823 | in progress. All name a |
| 824 | .I peer |
| 825 | as the second token: this is the peer the packet is apparently from, |
| 826 | though it may have been sent by an attacker instead. |
| 827 | .PP |
| 828 | In the descriptions below, |
| 829 | .I msgtoken |
| 830 | is one of the tokens |
| 831 | .BR pre-challenge , |
| 832 | .BR cookie , |
| 833 | .BR challenge , |
| 834 | .BR reply , |
| 835 | .BR switch-rq , |
| 836 | or |
| 837 | .BR switch-ok . |
| 838 | .SP |
| 839 | .BI "KX " peer " bad-expected-reply-log" |
| 840 | The challenges |
| 841 | .B tripe |
| 842 | uses in its protocol contain a check value which proves that the |
| 843 | challenge is honest. This message indicates that the check value |
| 844 | supplied is wrong: someone is attempting to use bogus challenges to |
| 845 | persuade your |
| 846 | .B tripe |
| 847 | server to leak private key information. No chance! |
| 848 | .SP |
| 849 | .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok" |
| 850 | A symmetrically-encrypted portion of a key-exchange message failed to |
| 851 | decrypt. |
| 852 | .SP |
| 853 | .BI "KX " peer " invalid " msgtoken |
| 854 | A key-exchange message was malformed. This almost certainly indicates a |
| 855 | bug somewhere. |
| 856 | .SP |
| 857 | .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok" |
| 858 | A message didn't contain the right magic data. This may be a replay of |
| 859 | some old exchange, or random packets being sent in an attempt to waste |
| 860 | CPU. |
| 861 | .SP |
| 862 | .BI "KX " peer " public-key-expired" |
| 863 | The peer's public key has expired. It's maintainer should have given |
| 864 | you a replacement before now. |
| 865 | .SP |
| 866 | .BI "KX " peer " sending-cookie" |
| 867 | We've received too many bogus pre-challenge messages. Someone is trying |
| 868 | to flood us with key-exchange messages and make us waste CPU on doing |
| 869 | hard asymmetric crypto sums. |
| 870 | .SP |
| 871 | .BI "KX " peer " unexpected " msgtoken |
| 872 | The message received wasn't appropriate for this stage of the key |
| 873 | exchange process. This may mean that one of our previous packets got |
| 874 | lost. For |
| 875 | .BR pre-challenge , |
| 876 | it may simply mean that the peer has recently restarted. |
| 877 | .SP |
| 878 | .BI "KX " peer " unknown-challenge" |
| 879 | The peer is asking for an answer to a challenge which we don't know |
| 880 | about. This may mean that we've been inundated with challenges from |
| 881 | some malicious source |
| 882 | .I who can read our messages |
| 883 | and discarded the valid one. |
| 884 | .SP |
| 885 | .BI "KX " peer " unknown-message 0x" nn |
| 886 | An unknown key-exchange message arrived. |
| 887 | .SS "PEER warnings" |
| 888 | These are largely concerned with management of peers and the low-level |
| 889 | details of the network protocol. The second word is usually the name of |
| 890 | a peer, or |
| 891 | .RB ` \- ' |
| 892 | if none is relevant. |
| 893 | .SP |
| 894 | .BI "PEER " peer " bad-packet no-type" |
| 895 | An empty packet arrived. This is very strange. |
| 896 | .SP |
| 897 | .BI "PEER " peer " bad-packet unknown-category 0x" nn |
| 898 | The message category |
| 899 | .I nn |
| 900 | (in hex) isn't understood. Probably a strange random packet from |
| 901 | somewhere; could be an unlikely bug. |
| 902 | .SP |
| 903 | .BI "PEER " peer " bad-packet unknown-type 0x" nn |
| 904 | The message type |
| 905 | .I nn |
| 906 | (in hex) isn't understood. Probably a strange random packet from |
| 907 | somewhere; could be an unlikely bug. |
| 908 | .SP |
| 909 | .BI "PEER " peer " corrupt-encrypted-ping" |
| 910 | The peer sent a ping response which matches an outstanding ping, but its |
| 911 | payload is wrong. There's definitely a bug somewhere. |
| 912 | .SP |
| 913 | .BI "PEER " peer " corrupt-transport-ping" |
| 914 | The peer (apparently) sent a ping response which matches an outstanding |
| 915 | ping, but its payload is wrong. Either there's a bug, or the bad guys |
| 916 | are playing tricks on you. |
| 917 | .SP |
| 918 | .BI "PEER " peer " decrypt-failed" |
| 919 | An encrypted IP packet failed to decrypt. It may have been mangled in |
| 920 | transit, or may be a very old packet from an expired previous session |
| 921 | key. There is usually a considerable overlap in the validity periods of |
| 922 | successive session keys, so this shouldn't occur unless the key exchange |
| 923 | takes ages or fails. |
| 924 | .SP |
| 925 | .BI "PEER " peer " malformed-encrypted-ping" |
| 926 | The peer sent a ping response which is hopelessly invalid. There's |
| 927 | definitely a bug somewhere. |
| 928 | .SP |
| 929 | .BI "PEER " peer " malformed-transport-ping" |
| 930 | The peer (apparently) sent a ping response which is hopelessly invalid. |
| 931 | Either there's a bug, or the bad guys are playing tricks on you. |
| 932 | .SP |
| 933 | .BI "PEER " peer " packet-build-failed" |
| 934 | There wasn't enough space in our buffer to put the packet we wanted to |
| 935 | send. Shouldn't happen. |
| 936 | .SP |
| 937 | .BI "PEER \- socket-read-error " ecode " " message |
| 938 | An error occurred trying to read an incoming packet. |
| 939 | .SP |
| 940 | .BI "PEER " peer " socket-write-error " ecode " " message |
| 941 | An error occurred attempting to send a network packet. We lost that |
| 942 | one. |
| 943 | .SP |
| 944 | .BI "PEER " peer " unexpected-encrypted-ping 0x" id |
| 945 | The peer sent an encrypted ping response whose id doesn't match any |
| 946 | outstanding ping. Maybe it was delayed for longer than the server was |
| 947 | willing to wait, or maybe the peer has gone mad. |
| 948 | .SP |
| 949 | .BI "PEER \- unexpected-source " address\fR... |
| 950 | A packet arrived from |
| 951 | .I address |
| 952 | (a network address \(en see above), but no peer is known at that |
| 953 | address. This may indicate a misconfiguration, or simply be a result of |
| 954 | one end of a connection being set up before the other. |
| 955 | .SP |
| 956 | .BI "PEER " peer " unexpected-transport-ping 0x" id |
| 957 | The peer (apparently) sent a transport ping response whose id doesn't |
| 958 | match any outstanding ping. Maybe it was delayed for longer than the |
| 959 | server was willing to wait, or maybe the peer has gone mad; or maybe |
| 960 | there are bad people trying to confuse you. |
| 961 | .SS "SERVER warnings" |
| 962 | These indicate problems concerning the server process as a whole. |
| 963 | .SP |
| 964 | .BI "SERVER ignore signal " name |
| 965 | A signal arrived, but the server ignored it. Currently this happens for |
| 966 | .B SIGHUP |
| 967 | because that's a popular way of telling daemons to re-read their |
| 968 | configuration files. Since |
| 969 | .B tripe |
| 970 | re-reads its keyrings automatically and has no other configuration |
| 971 | files, it's not relevant, but it seemed better to ignore the signal than |
| 972 | let the server die. |
| 973 | .SP |
| 974 | .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR] |
| 975 | A signal arrived and |
| 976 | .B tripe |
| 977 | is going to quit. |
| 978 | .SP |
| 979 | .BI "SERVER quit admin-request" |
| 980 | A client of the administration interface issued a |
| 981 | .B QUIT |
| 982 | command. |
| 983 | .SP |
| 984 | .BI "SERVER select-error " ecode " " message |
| 985 | An error occurred in the server's main event loop. This is bad: if it |
| 986 | happens too many times, the server will abort. |
| 987 | .SS "SYMM warnings" |
| 988 | These are concerned with the symmetric encryption and decryption |
| 989 | process. |
| 990 | .SP |
| 991 | .BI "SYMM replay old-sequence" |
| 992 | A packet was received with an old sequence number. It may just have |
| 993 | been delayed or duplicated, or it may have been an attempt at a replay |
| 994 | attack. |
| 995 | .SP |
| 996 | .BI "SYMM replay duplicated-sequence" |
| 997 | A packet was received with a sequence number we've definitely seen |
| 998 | before. It may be an accidental duplication because the 'net is like |
| 999 | that, or a deliberate attempt at a replay. |
| 1000 | .SS "TUN warnings" |
| 1001 | These concern the workings of the system-specific tunnel driver. The |
| 1002 | second word is the name of the tunnel interface in question, or |
| 1003 | .RB ` \- ' |
| 1004 | if none. |
| 1005 | .SP |
| 1006 | .BI "TUN \- bsd no-tunnel-devices" |
| 1007 | The driver couldn't find an available tunnel device. Maybe if you |
| 1008 | create some more |
| 1009 | .BI /dev/tun nn |
| 1010 | files, it will work. |
| 1011 | .SP |
| 1012 | .BI "TUN - " tun-name " open-error " device " " ecode " " message |
| 1013 | An attempt to open the tunnel device file |
| 1014 | .I device |
| 1015 | failed. |
| 1016 | .SP |
| 1017 | .BI "TUN \- linux config-error " ecode " " message |
| 1018 | Configuring the Linux TUN/TAP interface failed. |
| 1019 | .SP |
| 1020 | .BI "TUN " ifname " " tun-name " read-error " ecode " " message |
| 1021 | Reading from the tunnel device failed. |
| 1022 | .SP |
| 1023 | .BI "TUN " ifname " slip bad-escape" |
| 1024 | The SLIP driver encountered a escaped byte it wasn't expecting to see. |
| 1025 | The erroneous packet will be ignored. |
| 1026 | .SP |
| 1027 | .BI "TUN " ifname " slip eof" |
| 1028 | The SLIP driver encountered end-of-file on its input descriptor. |
| 1029 | Pending data is discarded, and no attempt is made to read any more data |
| 1030 | from that interface ever. |
| 1031 | .SP |
| 1032 | .BI "TUN " ifname " slip escape-end" |
| 1033 | The SLIP driver encountered an escaped `end' marker. This probably |
| 1034 | means that someone's been sending it junk. The erroneous packet is |
| 1035 | discarded, and we hope that we've rediscovered synchronization. |
| 1036 | .SP |
| 1037 | .BI "TUN \- slip fork-error " ecode " " message |
| 1038 | The SLIP driver encountered an error forking a child process while |
| 1039 | allocating a new dynamic interface. |
| 1040 | .SP |
| 1041 | .BI "TUN \- slip no-slip-interfaces" |
| 1042 | The driver ran out of static SLIP interfaces. Either preallocate more, |
| 1043 | or use dynamic SLIP interface allocation. |
| 1044 | .SP |
| 1045 | .BI "TUN " ifname " slip overflow" |
| 1046 | The SLIP driver gave up reading a packet because it got too large. |
| 1047 | .SP |
| 1048 | .BI "TUN \- slip pipe-error " ecode " " message |
| 1049 | The SLIP driver encountered an error creating pipes while allocating a |
| 1050 | new dynamic interface. |
| 1051 | .SP |
| 1052 | .BI "TUN \- slip read-ifname-failed " ecode " " message |
| 1053 | The SLIP driver encountered an error reading the name of a dynamically |
| 1054 | allocated interface. Maybe the allocation script is broken. |
| 1055 | .SP |
| 1056 | .BI "TUN \- unet config-error " ecode " " message |
| 1057 | Configuring the Linux Unet interface failed. Unet is obsolete and |
| 1058 | shouldn't be used any more. |
| 1059 | .SP |
| 1060 | .BI "TUN \- unet getinfo-error " ecode " " message |
| 1061 | Reading information about the Unet interface failed. Unet is obsolete |
| 1062 | and shouldn't be used any more. |
| 1063 | .SP |
| 1064 | .BI "TUN \- unet ifname-too-long" |
| 1065 | The Unet interface's name overflowed, so we couldn't read it properly. |
| 1066 | Unet is obsolete and shouldn't be used any more. |
| 1067 | .SS "USER warnings" |
| 1068 | These are issued by administration clients using the |
| 1069 | .B WARN |
| 1070 | command. |
| 1071 | .SP |
| 1072 | .BI "USER " tokens\fR... |
| 1073 | An administration client issued a warning. |
| 1074 | .\"-sep |
| 1075 | .SH "SUMMARY" |
| 1076 | .SS "Command responses" |
| 1077 | .nf |
| 1078 | .BI "BGFAIL " tag " " tokens \fR... |
| 1079 | .BI "BGINFO " tag " " tokens \fR... |
| 1080 | .BI "BGOK " tag |
| 1081 | .BI "FAIL " tokens \fR... |
| 1082 | .BI "INFO " tokens \fR... |
| 1083 | .B OK |
| 1084 | .fi |
| 1085 | .\"= summary |
| 1086 | .SH "SEE ALSO" |
| 1087 | .BR tripectl (1), |
| 1088 | .BR tripe (8). |
| 1089 | .PP |
| 1090 | .IR "The Trivial IP Encryption Protocol" . |
| 1091 | .SH "AUTHOR" |
| 1092 | Mark Wooding, <mdw@distorted.org.uk> |