coolaj86
/
le-acme-core.js
1
0
Fork 0
Code Issues Pull Requests Releases Activity

it is ready!

This commit is contained in:
AJ ONeal 2015-12-15 20:41:17 -08:00
parent ffb130ec0a
commit 550bcc484a
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -197,21 +197,28 @@ var certStore = {
The Goodies The Goodies
```javascript ```javascript
{ newRegUrl: '...' // no defaults, specify LeCore.nproductionServerUrl
// Accounts // Accounts
LeCore.registerNewAccount(options, cb) // returns (err, acmeUrls={newReg,newAuthz,newCert,revokeCert}) LeCore.registerNewAccount(options, cb) // returns (err, acmeUrls={newReg,newAuthz,newCert,revokeCert})
{ newRegUrl: '...' // no defaults, specify LeCore.newAuthz { newRegUrl: '<url>' // no defaults, specify acmeUrls.newAuthz
, email: '...' // valid email (server checks MX records) , email: '<email>' // valid email (server checks MX records)
, agreeToTerms: fn (tosUrl, cb) {} // callback to allow user interaction for tosUrl , accountPrivateKeyPem: '<ASCII PEM>' // callback to allow user interaction for tosUrl
// cb(err=null, agree=tosUrl) // must specify agree=tosUrl to continue (or falsey to end) , agreeToTerms: fn (tosUrl, cb) {} // must specify agree=tosUrl to continue (or falsey to end)
} }
// Registration // Registration
LeCore.getCertificate(options, cb) LeCore.getCertificate(options, cb) // returns (err, pems={ key, cert, ca })
{ newAuthzUrl: '...' // no defaults, specify acmeUrls.newAuthz { newAuthzUrl: '<url>' // specify acmeUrls.newAuthz
, newCertUrl: '<url>' // specify acmeUrls.newCert
, domainPrivateKeyPem: '<ASCII PEM>'
, accountPrivateKeyPem: '<ASCII PEM>'
, domains: ['example.com']
, setChallenge: fn (hostname, key, val, cb)
, removeChallenge: fn (hostname, key, cb)
}
``` ```
Helpers & Stuff Helpers & Stuff