README.md in r509-ca-http-0.2.2 vs README.md in r509-ca-http-0.3.0
- old
+ new
@@ -1,24 +1,23 @@
-#r509-ca-http
+#r509-ca-http [](http://travis-ci.org/r509/r509-ca-http) [](https://coveralls.io/r/r509/r509-ca-http)
r509-ca-http is an HTTP server that runs a certificate authority, for signing SSL certificates. It supports issuance and revocation, and is intended to be part of a complete certificate authority for use in production environments.
##Requirements/Installation
-You need r509 and sinatra. For development/tests you need rack-test and rspec.
+You need [r509](https://github.com/r509/r509) and sinatra. For development/tests you need rack-test and rspec.
## API
### GET /1/crl/:ca/get
-Get the most recently generate CRL for the given ```:ca```.
+Deprecated; will be removed in a future version. Use generate instead.
-A new CRL is generated when a certificate is revoked or unrevoked, or if you explicitly generate it.
### GET /1/crl/:ca/generate
-Explicitly generate and get a new CRL for the given ```:ca```.
+Generate and get a new CRL for the given ```:ca```.
### POST /1/certificate/issue
Issue a certificate.
@@ -35,17 +34,20 @@
subject[CN]=domain.com&subject[O]=orgname&subject[L]=locality
Optional POST parameters:
- extensions[subjectAlternativeName]
+- message\_digest
SAN names are provided like so:
extensions[subjectAlternativeName][]=domain1.com&extensions[subjectAlternativeName][]=domain2.com
The issue method will return the PEM text of the issued certificate.
+Please note that all fields subject/extension request fields encoded in a CSR are ignored in favor of the POST parameters.
+
### POST /1/certificate/revoke
Revoke a certificate.
Required POST parameters:
@@ -82,11 +84,11 @@
## certificate\_authorities (config.yaml)
You use the ```config.yaml``` file to specify information about your certificate authority. You can operate multiple certificate authorities, each of which can have multiple profiles, with one instance of r509-ca-http.
-Information about how to construct the YAML can be found at [the official r509 documentation](https://github.com/reaperhulk/r509#config).
+Information about how to construct the YAML can be found at [the official r509 documentation](https://github.com/reaperhulk/r509).
## Middleware (config.ru)
Running r509-ca-http will let you issue and revoke certificates. But that's not everything you need to do, if you're going to run a CA. You're going to need information about validity, and you may want to save a record of issued certificates to the filesystem.
@@ -94,9 +96,13 @@
- [r509-middleware-validity](https://github.com/sirsean/r509-middleware-validity)
- [r509-middleware-certwriter](https://github.com/sirsean/r509-middleware-certwriter)
After installing one or both of them, you'll have to edit your ```config.ru`` and/or ```config.yaml``` files.
+
+##Support
+
+You can file bugs on GitHub or join the #r509 channel on irc.freenode.net to ask questions.
## Rake tasks
There are a few things you can do with Rake.