Code Monkey home page Code Monkey logo

pebble's Introduction

Pebble

A miniature version of Boulder, Pebble is a small ACME-07 test server not suited for use as a production CA.

!!! WARNING !!!

WARNING

Pebble is NOT INTENDED FOR PRODUCTION USE. Pebble is for testing only.

By design Pebble will drop all of its state between invocations and will randomize keys/certificates used for issuance.

Goals

  1. Produce a simplified testing front end
  2. Move rapidly to gain ACME draft-07 experience
  3. Write "idealized" code that can be adopted back into Boulder
  4. Aggressively build in guardrails against non-testing usage

Pebble aims to address the need for ACME clients to have an easier to use, self-contained version of Boulder to test their clients against while developing ACME-06 support. Boulder is multi-process, requires heavy dependencies (MariaDB, RabbitMQ, etc), and is operationally complex to integrate with other projects.

Where possible Pebble aims to produce code that can be used to inform the pending Boulder support for ACME-06, through contribution of code as well as design lessons learned. Development of Pebble is meant to be rapid, and to produce a minimum working prototype on a short schedule.

In places where the ACME specification allows customization/CA choice Pebble aims to make choices different from Boulder. For instance, Pebble changes the path structures for its resources and directory endpoints to differ from Boulder. The goal is to emphasize client specification compatibility and to avoid "over-fitting" on Boulder and the Let's Encrypt production service.

Lastly, Pebble will enforce it's test-only usage by aggressively building in guardrails that make using it in a production setting impossible or very inconvenient. Pebble will not support non-volatile storage or persistence between executions. Pebble will also randomize keys/certificates used for issuance. Where possible Pebble will make decisions that force clients to implement ACME correctly (e.g. randomizing /directory endpoint URLs to ensure clients are not hardcoding URLs.)

Install

  1. Set up Go and your $GOPATH
  2. go get -u github.com/letsencrypt/pebble
  3. cd $GOPATH/src/github.com/letsencrypt/pebble && go install ./...
  4. pebble -h

Usage

pebble -config ./test/config/pebble-config.json

Testing at full speed

By default Pebble will sleep a random number of seconds (from 1 to 15) between individual challenge validation attempts. This ensures clients don't make assumptions about when the challenge is solved from the CA side by observing a single request for a challenge response. Instead clients must poll the challenge to observe the state since the CA may send many validation requests.

To test issuance "at full speed" with no artificial sleeps set the environment variable PEBBLE_VA_NOSLEEP to 1. E.g.

PEBBLE_VA_NOSLEEP=1 pebble -config ./test/config/pebble-config.json

Issuance

The easiest way to test issue with Pebble is to use chisel2 from the acme-v2 certbot branch (this is a work in progress).

  1. git clone -b acme-v2 https://github.com/certbot/certbot
  2. cd certbot
  3. letsencrypt-auto-source/letsencrypt-auto --os-packages-only
  4. ./tools/venv.sh
  5. . venev/bin/activate
  6. python ./tools/chisel2.py example.com

pebble's People

Contributors

cpu avatar jsha avatar justinazoff avatar shred avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.