Preparing:
git submodule update --init --recursive
svn co http://gyp.googlecode.com/svn/trunk build/gypBuilding:
./gyp_bud
make -C out/The result will be located at: ./out/Release/bud.
To start bud - create configuration file using this template and:
bud --conf conf.jsonBud is using JSON as a configuration format. Run bud --default-config
to get default configuration options (with comments and description below):
{
// Spawn detached "daemon" process
"daemon": false,
// Number of workers to use, if 0 - only one process will be spawned.
"workers": 1,
// Timeout after which workers will be restarted (if they die)
"restart_timeout": 250,
// Logging configuration
"log": {
// Minimum observable log level, possible values:
// "debug", "notice", "info" (default), "warning", "fatal"
"level": "info",
// syslog facility to use, could be:
// "auth", "cron", "kern", "lpr", "mail", "news", "syslog"
// "deamon", "uucp", "local0", ... "local7"
"facility": "user",
// if true - logging will be printed to standard output
"stdio": true,
// if true - syslog will be used for logging
"syslog": true
},
// Frontend configuration (i.e. TLS/SSL server)
"frontend": {
"port": 1443,
"host": "0.0.0.0",
// tcp keepalive value (in seconds)
"keepalive": 3600,
// if true - HAProxy compatible proxyline will be sent:
// "PROXY TCP4 ... ... ... ..."
"proxyline": false,
// if true - server listed ciphers will be preferenced
"server_preference": true,
// Which protocol versions to support:
// **optional**, default: "ssl23"
// "ssl23" (implies tls1.*) , "ssl3", "tls1", "tls1.1", "tls1.2"
"security": "ssl23",
// Path to default TLS certificate
"cert": "keys/cert.pem",
// Path to default TLS private key
"key": "keys/key.pem",
// **Optional** Cipher suites to use
"ciphers": null,
// **Optional** ECDH Curve to use
"ecdh": "prime256v1",
// **Optional** NPN protocols to advertise
"npn": ["http/1.1", "http/1.0"],
// NOTE: Better leave this default:
// **Optional** Renegotiation window in seconds
"reneg_window": 300,
// **Optional** Maximum number of renegotiations in a window
"reneg_limit": 3,
// **Optional** If true - enable SSL3 support
"ssl3": false
},
// Backend configuration (i.e. address of Cleartext server)
"backend": {
"port": 8000,
"host": "127.0.0.1",
"keepalive": 3600
},
// SNI context loading
"sni": {
"enabled": false,
"port": 9000,
"host": "127.0.0.1",
// %s will be replaced with actual servername
"query": "/bud/sni/%s"
},
// OCSP Stapling response loading
"stapling": {
"enabled": false,
"port": 9000,
"host": "127.0.0.1",
// %s will be replaced with actual servername
"query": "/bud/stapling/%s"
},
// Secure contexts (i.e. Server Name Indication support)
"contexts": [{
// Servername to match against
"servername": "blog.indutny.com",
// Path to TLS certificate
"cert": "keys/cert.pem",
// Path to TLS private key
"key": "keys/key.pem",
// Cipherlist to use (overrides frontend.ciphers, if not null)
"ciphers": null,
// ECDH curve to use, overrides frontend.ecdh
"ecdh": null,
// NPN protocols to advertise
// (overrides frontend.npn, if not null)
"npn": ["http/1.1", "http/1.0"]
}]
}To start bud - create configuration file using this template and:
bud --conf conf.jsonIf you have enabled SNI lookup (sni.enabled set to true), on every TLS
connection a request to the HTTP server will be made (using sni.host,
sni.port and sni.query as url template). The response should be a JSON
of the following form:
{
"cert": "certificate contents",
"key": "key contents",
// Optional
"npn": [],
// Optional
"ciphers": "...",
// Optional
"ecdh": "..."
}Or any other JSON and a 404 status code, if SNI certificateis not found.
If optional fields are not present - their value would be taken from frontend
object in configuration file.
OCSP Stapling has exactly the same configuration options as SNI Storage. Main difference is that 2 requests to OCSP Stapling server could be made by bud:
GET /stapling_url/<stapling_id>- to probe backend's cachePOST /stapling_url/<stapling_id>with JSON body:{"url":"http://some.ocsp.server.com/","ocsp":"base64-encoded-data"}.
For first request, if backend has cached OCSP response for given
<stapling_id>, backend should respond with following JSON:
{"response":"base64-encoded-response"}
Or with 404 status code and any other JSON.
For the second request, backend should send a POST request to the OCSP server
given in the JSON body. This request should have Content-Type header set
to application/ocsp-request and a decoded (from base64) ocsp field from
body.
The response to bud should be the same as in the first case, base64-encoded data received from OCSP server.
Example OCSP+SNI backend implementation in node.js could be found here.
This software is licensed under the MIT License.
Copyright Fedor Indutny, 2013.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.