alexvanin/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

Update client docs

Browse source
This commit is contained in:
xenolf 2015-12-27 20:56:02 +01:00
parent 8362f35823
commit fce9468e1e
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
acme/client.go
View file

@ -56,15 +56,9 @@ type Client struct {
solvers map[string]solver solvers map[string]solver
} }
// NewClient creates a new ACME client on behalf of user. The client will depend on // NewClient creates a new ACME client on behalf of the user. The client will depend on
// the ACME directory located at caDirURL for the rest of its actions. It will // the ACME directory located at caDirURL for the rest of its actions. It will
// generate private keys for certificates of size keyBits. And, if the challenge // generate private keys for certificates of size keyBits.
// type requires it, the client will open a port at optPort to solve the challenge.
//
// If optSolvers is nil, the value of DefaultSolvers is used. If given explicitly,
// it is a set of solver names to enable. The "http-01" and "tls-sni-01" solvers
// take an optional TCP port to listen on after a colon, e.g. "http-01:80". If
// the port is not specified, the port required by the spec will be used.
func NewClient(caDirURL string, user User, keyBits int) (*Client, error) { func NewClient(caDirURL string, user User, keyBits int) (*Client, error) {
privKey := user.GetPrivateKey() privKey := user.GetPrivateKey()
if privKey == nil { if privKey == nil {
@ -106,6 +100,7 @@ func NewClient(caDirURL string, user User, keyBits int) (*Client, error) {
} }
// SetHTTPPort specifies a custom port to be used for HTTP based challenges. // SetHTTPPort specifies a custom port to be used for HTTP based challenges.
// If this option is not used, the default port 80 will be used.
func (c *Client) SetHTTPPort(port string) { func (c *Client) SetHTTPPort(port string) {
if chlng, ok := c.solvers["http-01"]; ok { if chlng, ok := c.solvers["http-01"]; ok {
chlng.(*httpChallenge).optPort = port chlng.(*httpChallenge).optPort = port
@ -113,6 +108,7 @@ func (c *Client) SetHTTPPort(port string) {
} }
// SetTLSPort specifies a custom port to be used for TLS based challenges. // SetTLSPort specifies a custom port to be used for TLS based challenges.
// If this option is not used, the default port 443 will be used.
func (c *Client) SetTLSPort(port string) { func (c *Client) SetTLSPort(port string) {
if chlng, ok := c.solvers["tls-sni-01"]; ok { if chlng, ok := c.solvers["tls-sni-01"]; ok {
chlng.(*tlsSNIChallenge).optPort = port chlng.(*tlsSNIChallenge).optPort = port
@ -182,6 +178,8 @@ func (c *Client) AgreeToTOS() error {
// domains are added using the Subject Alternate Names extension. // domains are added using the Subject Alternate Names extension.
// If bundle is true, the []byte contains both the issuer certificate and // If bundle is true, the []byte contains both the issuer certificate and
// your issued certificate as a bundle. // your issued certificate as a bundle.
// This function will never return a partial certificate. If one domain in the list fails,
// the whole certificate will fail.
func (c *Client) ObtainCertificate(domains []string, bundle bool) (CertificateResource, map[string]error) { func (c *Client) ObtainCertificate(domains []string, bundle bool) (CertificateResource, map[string]error) {
if bundle { if bundle {
logf("[INFO][%s] acme: Obtaining bundled SAN certificate", strings.Join(domains, ", ")) logf("[INFO][%s] acme: Obtaining bundled SAN certificate", strings.Join(domains, ", "))