doc/file.README.html in r509-ca-http-0.2.2 vs doc/file.README.html in r509-ca-http-0.3.0

- old
+ new

@@ -1,10 +1,10 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> - <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title> File: README &mdash; Documentation by YARD 0.8.6.1 @@ -59,29 +59,27 @@ <div class="clear"></div> </div> <iframe id="search_frame"></iframe> - <div id="content"><div id='filecontents'><h1>r509-ca-http</h1> + <div id="content"><div id='filecontents'><h1>r509-ca-http <a href="http://travis-ci.org/r509/r509-ca-http"><img src="https://secure.travis-ci.org/r509/r509-ca-http.png" alt="Build Status"></a> <a href="https://coveralls.io/r/r509/r509-ca-http"><img src="https://coveralls.io/repos/r509/r509-ca-http/badge.png" alt="Coverage Status"></a></h1> <p>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.</p> <h2>Requirements/Installation</h2> -<p>You need r509 and sinatra. For development/tests you need rack-test and rspec.</p> +<p>You need <a href="https://github.com/r509/r509">r509</a> and sinatra. For development/tests you need rack-test and rspec.</p> <h2>API</h2> <h3>GET /1/crl/:ca/get</h3> -<p>Get the most recently generate CRL for the given <code>:ca</code>.</p> +<p>Deprecated; will be removed in a future version. Use generate instead.</p> -<p>A new CRL is generated when a certificate is revoked or unrevoked, or if you explicitly generate it.</p> - <h3>GET /1/crl/:ca/generate</h3> -<p>Explicitly generate and get a new CRL for the given <code>:ca</code>.</p> +<p>Generate and get a new CRL for the given <code>:ca</code>.</p> <h3>POST /1/certificate/issue</h3> <p>Issue a certificate.</p> @@ -102,19 +100,22 @@ <p>Optional POST parameters:</p> <ul> <li>extensions[subjectAlternativeName]</li> +<li>message_digest</li> </ul> <p>SAN names are provided like so:</p> <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_extensions'>extensions</span><span class='lbracket'>[</span><span class='id identifier rubyid_subjectAlternativeName'>subjectAlternativeName</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='op'>=</span><span class='id identifier rubyid_domain1'>domain1</span><span class='period'>.</span><span class='id identifier rubyid_com'>com</span><span class='op'>&amp;</span><span class='id identifier rubyid_extensions'>extensions</span><span class='lbracket'>[</span><span class='id identifier rubyid_subjectAlternativeName'>subjectAlternativeName</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='op'>=</span><span class='id identifier rubyid_domain2'>domain2</span><span class='period'>.</span><span class='id identifier rubyid_com'>com</span> </code></pre> <p>The issue method will return the PEM text of the issued certificate.</p> +<p>Please note that all fields subject/extension request fields encoded in a CSR are ignored in favor of the POST parameters.</p> + <h3>POST /1/certificate/revoke</h3> <p>Revoke a certificate.</p> <p>Required POST parameters:</p> @@ -157,11 +158,11 @@ <h2>certificate_authorities (config.yaml)</h2> <p>You use the <code>config.yaml</code> 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.</p> -<p>Information about how to construct the YAML can be found at <a href="https://github.com/reaperhulk/r509#config">the official r509 documentation</a>.</p> +<p>Information about how to construct the YAML can be found at <a href="https://github.com/reaperhulk/r509">the official r509 documentation</a>.</p> <h2>Middleware (config.ru)</h2> <p>Running r509-ca-http will let you issue and revoke certificates. But that&#39;s not everything you need to do, if you&#39;re going to run a CA. You&#39;re going to need information about validity, and you may want to save a record of issued certificates to the filesystem.</p> @@ -172,10 +173,14 @@ <li><a href="https://github.com/sirsean/r509-middleware-certwriter">r509-middleware-certwriter</a></li> </ul> <p>After installing one or both of them, you&#39;ll have to edit your <code>config.ru`` and/or</code>config.yaml``` files.</p> +<h2>Support</h2> + +<p>You can file bugs on GitHub or join the #r509 channel on irc.freenode.net to ask questions.</p> + <h2>Rake tasks</h2> <p>There are a few things you can do with Rake.</p> <p><code>rake spec</code></p> @@ -198,12 +203,12 @@ <p>Generate documentation.</p> </div></div> <div id="footer"> - Generated on Wed May 15 11:10:00 2013 by + Generated on Sun Jan 26 14:20:49 2014 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.6.1 (ruby-1.9.3). + 0.8.6.1 (ruby-2.0.0). </div> </body> </html> \ No newline at end of file