bokbok
Documentation
Not logged in

Introduction

Bokbok is a toolkit for exposing and consuming APIs between processes.

It supports:

Usage

$ chicken-install bokbok

Concepts

Creating connections

A server is created by start-server, given an address to bind to (IPv4 or UNIX socket). When connections come in, an "open handler" is notified of the new connection.

The server can be asked to terminate with stop-server!. You can block until it's died with wait-until-server-stopped.

A client is created by calling open-connection, given an address to connect to, and creates a connection.

Using connections

Once connection setup is complete, connections are the same for both client and server; that distinction is purely a matter of who created the connection. Both sides can call request! to send a request to the other side or close-connection! to close the connection - and both sides have a request handler and a close handler ready to handle those cases.

Normally the "client" calls close-connection!, but that's just convention.

Encryption

If a username and key (which can be generated from a string by calling passphrase->key is given when open-connection is called, then the connection is opened as an encrypted connection. It won't work very well if the wrong key for that username is provided, or the username is unknown on the server.

If a server is started in encrypted mode, a key lookup function must be provided. When a connection comes in, the username provided by the client is passed to the key lookup function, which must either return a key or #f if the user is not allowed to connect. If the key returend matches the one the user provides, the connection will succeed and be encrypted.

A random session key is actually used for encryption, chosen by the client; the user's key is used to encrypt the session key for transmission to the server, then discarded.