-
-
Notifications
You must be signed in to change notification settings - Fork 703
/
acme.go
726 lines (668 loc) · 23.1 KB
/
acme.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
// Copyright (C) 2019-2022 Nicola Murino
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// Package acme provides automatic access to certificates from Let's Encrypt and any other ACME-based CA
// The code here is largely coiped from https://github.com/go-acme/lego/tree/master/cmd
// This package is intended to provide basic functionality for obtaining and renewing certificates
// and implements the "HTTP-01" and "TLSALPN-01" challenge types.
// For more advanced features use external tools such as "lego"
package acme
import (
"crypto"
"crypto/x509"
"encoding/json"
"encoding/pem"
"errors"
"fmt"
"math/rand"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/go-acme/lego/v4/certcrypto"
"github.com/go-acme/lego/v4/certificate"
"github.com/go-acme/lego/v4/challenge"
"github.com/go-acme/lego/v4/challenge/http01"
"github.com/go-acme/lego/v4/challenge/tlsalpn01"
"github.com/go-acme/lego/v4/lego"
"github.com/go-acme/lego/v4/log"
"github.com/go-acme/lego/v4/providers/http/webroot"
"github.com/go-acme/lego/v4/registration"
"github.com/robfig/cron/v3"
"github.com/drakkan/sftpgo/v2/internal/common"
"github.com/drakkan/sftpgo/v2/internal/ftpd"
"github.com/drakkan/sftpgo/v2/internal/httpd"
"github.com/drakkan/sftpgo/v2/internal/logger"
"github.com/drakkan/sftpgo/v2/internal/telemetry"
"github.com/drakkan/sftpgo/v2/internal/util"
"github.com/drakkan/sftpgo/v2/internal/version"
"github.com/drakkan/sftpgo/v2/internal/webdavd"
)
const (
logSender = "acme"
)
var (
config *Configuration
scheduler *cron.Cron
logMode int
)
// GetCertificates tries to obtain the certificates for the configured domains
func GetCertificates() error {
if config == nil {
return errors.New("acme is disabled")
}
return config.getCertificates()
}
// HTTP01Challenge defines the configuration for HTTP-01 challenge type
type HTTP01Challenge struct {
Port int `json:"port" mapstructure:"port"`
WebRoot string `json:"webroot" mapstructure:"webroot"`
ProxyHeader string `json:"proxy_header" mapstructure:"proxy_header"`
}
func (c *HTTP01Challenge) isEnabled() bool {
return c.Port > 0 || c.WebRoot != ""
}
func (c *HTTP01Challenge) validate() error {
if !c.isEnabled() {
return nil
}
if c.WebRoot != "" {
if !filepath.IsAbs(c.WebRoot) {
return fmt.Errorf("invalid HTTP-01 challenge web root, please set an absolute path")
}
_, err := os.Stat(c.WebRoot)
if err != nil {
return fmt.Errorf("invalid HTTP-01 challenge web root: %w", err)
}
} else {
if c.Port > 65535 {
return fmt.Errorf("invalid HTTP-01 challenge port: %d", c.Port)
}
}
return nil
}
// TLSALPN01Challenge defines the configuration for TLSALPN-01 challenge type
type TLSALPN01Challenge struct {
Port int `json:"port" mapstructure:"port"`
}
func (c *TLSALPN01Challenge) isEnabled() bool {
return c.Port > 0
}
func (c *TLSALPN01Challenge) validate() error {
if !c.isEnabled() {
return nil
}
if c.Port > 65535 {
return fmt.Errorf("invalid TLSALPN-01 challenge port: %d", c.Port)
}
return nil
}
// Configuration holds the ACME configuration
type Configuration struct {
Email string `json:"email" mapstructure:"email"`
KeyType string `json:"key_type" mapstructure:"key_type"`
CertsPath string `json:"certs_path" mapstructure:"certs_path"`
CAEndpoint string `json:"ca_endpoint" mapstructure:"ca_endpoint"`
// if a certificate is to be valid for multiple domains specify the names separated by commas,
// for example: example.com,www.example.com
Domains []string `json:"domains" mapstructure:"domains"`
RenewDays int `json:"renew_days" mapstructure:"renew_days"`
HTTP01Challenge HTTP01Challenge `json:"http01_challenge" mapstructure:"http01_challenge"`
TLSALPN01Challenge TLSALPN01Challenge `json:"tls_alpn01_challenge" mapstructure:"tls_alpn01_challenge"`
accountConfigPath string
accountKeyPath string
lockPath string
tempDir string
}
// Initialize validates and set the configuration
func (c *Configuration) Initialize(configDir string, checkRenew bool) error {
config = nil
setLogMode(checkRenew)
c.checkDomains()
if len(c.Domains) == 0 {
acmeLog(logger.LevelInfo, "no domains configured, acme disabled")
return nil
}
if c.Email == "" || !util.IsEmailValid(c.Email) {
return fmt.Errorf("invalid email address %#v", c.Email)
}
if c.RenewDays < 1 {
return fmt.Errorf("invalid number of days remaining before renewal: %d", c.RenewDays)
}
supportedKeyTypes := []string{
string(certcrypto.EC256),
string(certcrypto.EC384),
string(certcrypto.RSA2048),
string(certcrypto.RSA4096),
string(certcrypto.RSA8192),
}
if !util.Contains(supportedKeyTypes, c.KeyType) {
return fmt.Errorf("invalid key type %#v", c.KeyType)
}
caURL, err := url.Parse(c.CAEndpoint)
if err != nil {
return fmt.Errorf("invalid CA endopoint: %w", err)
}
if !util.IsFileInputValid(c.CertsPath) {
return fmt.Errorf("invalid certs path %#v", c.CertsPath)
}
if !filepath.IsAbs(c.CertsPath) {
c.CertsPath = filepath.Join(configDir, c.CertsPath)
}
err = os.MkdirAll(c.CertsPath, 0700)
if err != nil {
return fmt.Errorf("unable to create certs path %#v: %w", c.CertsPath, err)
}
c.tempDir = filepath.Join(c.CertsPath, "temp")
err = os.MkdirAll(c.CertsPath, 0700)
if err != nil {
return fmt.Errorf("unable to create certs temp path %#v: %w", c.tempDir, err)
}
serverPath := strings.NewReplacer(":", "_", "/", string(os.PathSeparator)).Replace(caURL.Host)
accountPath := filepath.Join(c.CertsPath, serverPath)
err = os.MkdirAll(accountPath, 0700)
if err != nil {
return fmt.Errorf("unable to create account path %#v: %w", accountPath, err)
}
c.accountConfigPath = filepath.Join(accountPath, c.Email+".json")
c.accountKeyPath = filepath.Join(accountPath, c.Email+".key")
c.lockPath = filepath.Join(c.CertsPath, "lock")
if err = c.validateChallenges(); err != nil {
return err
}
acmeLog(logger.LevelInfo, "configured domains: %+v", c.Domains)
config = c
if checkRenew {
return startScheduler()
}
return nil
}
func (c *Configuration) validateChallenges() error {
if !c.HTTP01Challenge.isEnabled() && !c.TLSALPN01Challenge.isEnabled() {
return fmt.Errorf("no challenge type defined")
}
if err := c.HTTP01Challenge.validate(); err != nil {
return err
}
if err := c.TLSALPN01Challenge.validate(); err != nil {
return err
}
return nil
}
func (c *Configuration) checkDomains() {
var domains []string
for _, domain := range c.Domains {
domain = strings.TrimSpace(domain)
if domain == "" {
continue
}
if d, ok := isDomainValid(domain); ok {
domains = append(domains, d)
}
}
c.Domains = util.RemoveDuplicates(domains, true)
}
func (c *Configuration) setLockTime() error {
lockTime := fmt.Sprintf("%v", util.GetTimeAsMsSinceEpoch(time.Now()))
err := os.WriteFile(c.lockPath, []byte(lockTime), 0600)
if err != nil {
acmeLog(logger.LevelError, "unable to save lock time to %#v: %v", c.lockPath, err)
return fmt.Errorf("unable to save lock time: %w", err)
}
acmeLog(logger.LevelDebug, "lock time saved: %#v", lockTime)
return nil
}
func (c *Configuration) getLockTime() (time.Time, error) {
content, err := os.ReadFile(c.lockPath)
if err != nil {
if os.IsNotExist(err) {
acmeLog(logger.LevelDebug, "lock file %#v not found", c.lockPath)
return time.Time{}, nil
}
acmeLog(logger.LevelError, "unable to read lock file %#v: %v", c.lockPath, err)
return time.Time{}, err
}
msec, err := strconv.ParseInt(strings.TrimSpace(string(content)), 10, 64)
if err != nil {
acmeLog(logger.LevelError, "unable to parse lock time: %v", err)
return time.Time{}, fmt.Errorf("unable to parse lock time: %w", err)
}
return util.GetTimeFromMsecSinceEpoch(msec), nil
}
func (c *Configuration) saveAccount(account *account) error {
jsonBytes, err := json.MarshalIndent(account, "", "\t")
if err != nil {
return err
}
err = os.WriteFile(c.accountConfigPath, jsonBytes, 0600)
if err != nil {
acmeLog(logger.LevelError, "unable to save account to file %#v: %v", c.accountConfigPath, err)
return fmt.Errorf("unable to save account: %w", err)
}
return nil
}
func (c *Configuration) getAccount(privateKey crypto.PrivateKey) (account, error) {
_, err := os.Stat(c.accountConfigPath)
if err != nil && os.IsNotExist(err) {
acmeLog(logger.LevelDebug, "account does not exist")
return account{Email: c.Email, key: privateKey}, nil
}
var account account
fileBytes, err := os.ReadFile(c.accountConfigPath)
if err != nil {
acmeLog(logger.LevelError, "unable to read account from file %#v: %v", c.accountConfigPath, err)
return account, fmt.Errorf("unable to read account from file: %w", err)
}
err = json.Unmarshal(fileBytes, &account)
if err != nil {
acmeLog(logger.LevelError, "invalid account file content: %v", err)
return account, fmt.Errorf("unable to parse account file as JSON: %w", err)
}
account.key = privateKey
if account.Registration == nil || account.Registration.Body.Status == "" {
acmeLog(logger.LevelInfo, "couldn't load account but got a key. Try to look the account up")
reg, err := c.tryRecoverRegistration(privateKey)
if err != nil {
acmeLog(logger.LevelError, "unable to look the account up: %v", err)
return account, fmt.Errorf("unable to look the account up: %w", err)
}
account.Registration = reg
err = c.saveAccount(&account)
if err != nil {
return account, err
}
}
return account, nil
}
func (c *Configuration) loadPrivateKey() (crypto.PrivateKey, error) {
keyBytes, err := os.ReadFile(c.accountKeyPath)
if err != nil {
acmeLog(logger.LevelError, "unable to read account key from file %#v: %v", c.accountKeyPath, err)
return nil, fmt.Errorf("unable to read account key: %w", err)
}
keyBlock, _ := pem.Decode(keyBytes)
var privateKey crypto.PrivateKey
switch keyBlock.Type {
case "RSA PRIVATE KEY":
privateKey, err = x509.ParsePKCS1PrivateKey(keyBlock.Bytes)
case "EC PRIVATE KEY":
privateKey, err = x509.ParseECPrivateKey(keyBlock.Bytes)
default:
err = fmt.Errorf("unknown private key type %#v", keyBlock.Type)
}
if err != nil {
acmeLog(logger.LevelError, "unable to parse private key from file %#v: %v", c.accountKeyPath, err)
return privateKey, fmt.Errorf("unable to parse private key: %w", err)
}
return privateKey, nil
}
func (c *Configuration) generatePrivateKey() (crypto.PrivateKey, error) {
privateKey, err := certcrypto.GeneratePrivateKey(certcrypto.KeyType(c.KeyType))
if err != nil {
acmeLog(logger.LevelError, "unable to generate private key: %v", err)
return nil, fmt.Errorf("unable to generate private key: %w", err)
}
certOut, err := os.Create(c.accountKeyPath)
if err != nil {
acmeLog(logger.LevelError, "unable to save private key to file %#v: %v", c.accountKeyPath, err)
return nil, fmt.Errorf("unable to save private key: %w", err)
}
defer certOut.Close()
pemKey := certcrypto.PEMBlock(privateKey)
err = pem.Encode(certOut, pemKey)
if err != nil {
acmeLog(logger.LevelError, "unable to encode private key: %v", err)
return nil, fmt.Errorf("unable to encode private key: %w", err)
}
acmeLog(logger.LevelDebug, "new account private key generated")
return privateKey, nil
}
func (c *Configuration) getPrivateKey() (crypto.PrivateKey, error) {
_, err := os.Stat(c.accountKeyPath)
if err != nil && os.IsNotExist(err) {
acmeLog(logger.LevelDebug, "private key file %#v does not exist, generating new private key", c.accountKeyPath)
return c.generatePrivateKey()
}
acmeLog(logger.LevelDebug, "loading private key from file %#v, stat error: %v", c.accountKeyPath, err)
return c.loadPrivateKey()
}
func (c *Configuration) loadCertificatesForDomain(domain string) ([]*x509.Certificate, error) {
domain = sanitizedDomain(domain)
acmeLog(logger.LevelDebug, "loading certificates for domain %#v", domain)
content, err := os.ReadFile(filepath.Join(c.CertsPath, domain+".crt"))
if err != nil {
acmeLog(logger.LevelError, "unable to load certificates for domain %#v: %v", domain, err)
return nil, fmt.Errorf("unable to load certificates for domain %#v: %w", domain, err)
}
certs, err := certcrypto.ParsePEMBundle(content)
if err != nil {
acmeLog(logger.LevelError, "unable to parse certificates for domain %#v: %v", domain, err)
return certs, fmt.Errorf("unable to parse certificates for domain %#v: %w", domain, err)
}
return certs, nil
}
func (c *Configuration) needRenewal(x509Cert *x509.Certificate, domain string) bool {
if x509Cert.IsCA {
acmeLog(logger.LevelError, "certificate bundle starts with a CA certificate, cannot renew domain %v", domain)
return false
}
notAfter := int(time.Until(x509Cert.NotAfter).Hours() / 24.0)
if notAfter > c.RenewDays {
acmeLog(logger.LevelDebug, "the certificate for domain %#v expires in %d days, no renewal", domain, notAfter)
return false
}
return true
}
func (c *Configuration) setup() (*account, *lego.Client, error) {
privateKey, err := c.getPrivateKey()
if err != nil {
return nil, nil, err
}
account, err := c.getAccount(privateKey)
if err != nil {
return nil, nil, err
}
config := lego.NewConfig(&account)
config.CADirURL = c.CAEndpoint
config.Certificate.KeyType = certcrypto.KeyType(c.KeyType)
config.UserAgent = fmt.Sprintf("SFTPGo/%v", version.Get().Version)
client, err := lego.NewClient(config)
if err != nil {
acmeLog(logger.LevelError, "unable to get ACME client: %v", err)
return nil, nil, fmt.Errorf("unable to get ACME client: %w", err)
}
err = c.setupChalleges(client)
if err != nil {
return nil, nil, err
}
return &account, client, nil
}
func (c *Configuration) setupChalleges(client *lego.Client) error {
client.Challenge.Remove(challenge.DNS01)
if c.HTTP01Challenge.isEnabled() {
if c.HTTP01Challenge.WebRoot != "" {
acmeLog(logger.LevelDebug, "configuring HTTP-01 web root challenge, path %#v", c.HTTP01Challenge.WebRoot)
providerServer, err := webroot.NewHTTPProvider(c.HTTP01Challenge.WebRoot)
if err != nil {
acmeLog(logger.LevelError, "unable to create HTTP-01 web root challenge provider from path %#v: %v",
c.HTTP01Challenge.WebRoot, err)
return fmt.Errorf("unable to create HTTP-01 web root challenge provider: %w", err)
}
err = client.Challenge.SetHTTP01Provider(providerServer)
if err != nil {
acmeLog(logger.LevelError, "unable to set HTTP-01 challenge provider: %v", err)
return fmt.Errorf("unable to set HTTP-01 challenge provider: %w", err)
}
} else {
acmeLog(logger.LevelDebug, "configuring HTTP-01 challenge, port %d", c.HTTP01Challenge.Port)
providerServer := http01.NewProviderServer("", fmt.Sprintf("%d", c.HTTP01Challenge.Port))
if c.HTTP01Challenge.ProxyHeader != "" {
acmeLog(logger.LevelDebug, "setting proxy header to \"%s\"", c.HTTP01Challenge.ProxyHeader)
providerServer.SetProxyHeader(c.HTTP01Challenge.ProxyHeader)
}
err := client.Challenge.SetHTTP01Provider(providerServer)
if err != nil {
acmeLog(logger.LevelError, "unable to set HTTP-01 challenge provider: %v", err)
return fmt.Errorf("unable to set HTTP-01 challenge provider: %w", err)
}
}
} else {
client.Challenge.Remove(challenge.HTTP01)
}
if c.TLSALPN01Challenge.isEnabled() {
acmeLog(logger.LevelDebug, "configuring TLSALPN-01 challenge, port %d", c.TLSALPN01Challenge.Port)
err := client.Challenge.SetTLSALPN01Provider(tlsalpn01.NewProviderServer("", fmt.Sprintf("%d", c.TLSALPN01Challenge.Port)))
if err != nil {
acmeLog(logger.LevelError, "unable to set TLSALPN-01 challenge provider: %v", err)
return fmt.Errorf("unable to set TLSALPN-01 challenge provider: %w", err)
}
} else {
client.Challenge.Remove(challenge.TLSALPN01)
}
return nil
}
func (c *Configuration) register(client *lego.Client) (*registration.Resource, error) {
return client.Registration.Register(registration.RegisterOptions{TermsOfServiceAgreed: true})
}
func (c *Configuration) tryRecoverRegistration(privateKey crypto.PrivateKey) (*registration.Resource, error) {
config := lego.NewConfig(&account{key: privateKey})
config.CADirURL = c.CAEndpoint
config.UserAgent = fmt.Sprintf("SFTPGo/%v", version.Get().Version)
client, err := lego.NewClient(config)
if err != nil {
acmeLog(logger.LevelError, "unable to get the ACME client: %v", err)
return nil, err
}
return client.Registration.ResolveAccountByKey()
}
func (c *Configuration) obtainAndSaveCertificate(client *lego.Client, domain string) error {
var domains []string
for _, d := range strings.Split(domain, ",") {
d = strings.TrimSpace(d)
if d != "" {
domains = append(domains, d)
}
}
acmeLog(logger.LevelInfo, "requesting certificates for domains %+v", domains)
request := certificate.ObtainRequest{
Domains: domains,
Bundle: true,
MustStaple: false,
PreferredChain: "",
AlwaysDeactivateAuthorizations: false,
}
cert, err := client.Certificate.Obtain(request)
if err != nil {
acmeLog(logger.LevelError, "unable to obtain certificates for domains %+v: %v", domains, err)
return fmt.Errorf("unable to obtain certificates: %w", err)
}
domain = sanitizedDomain(domain)
err = os.WriteFile(filepath.Join(c.CertsPath, domain+".crt"), cert.Certificate, 0600)
if err != nil {
acmeLog(logger.LevelError, "unable to save certificate for domain %v: %v", domain, err)
return fmt.Errorf("unable to save certificate: %w", err)
}
err = os.WriteFile(filepath.Join(c.CertsPath, domain+".key"), cert.PrivateKey, 0600)
if err != nil {
acmeLog(logger.LevelError, "unable to save private key for domain %v: %v", domain, err)
return fmt.Errorf("unable to save private key: %w", err)
}
jsonBytes, err := json.MarshalIndent(cert, "", "\t")
if err != nil {
acmeLog(logger.LevelError, "unable to marshal certificate resources for domain %v: %v", domain, err)
return err
}
err = os.WriteFile(filepath.Join(c.CertsPath, domain+".json"), jsonBytes, 0600)
if err != nil {
acmeLog(logger.LevelError, "unable to save certificate resources for domain %v: %v", domain, err)
return fmt.Errorf("unable to save certificate resources: %w", err)
}
acmeLog(logger.LevelInfo, "certificates for domains %+v saved", domains)
return nil
}
func (c *Configuration) getCertificates() error {
account, client, err := c.setup()
if err != nil {
return err
}
if account.Registration == nil {
reg, err := c.register(client)
if err != nil {
acmeLog(logger.LevelError, "unable to register account: %v", err)
return fmt.Errorf("unable to register account: %w", err)
}
account.Registration = reg
err = c.saveAccount(account)
if err != nil {
return err
}
}
for _, domain := range c.Domains {
err = c.obtainAndSaveCertificate(client, domain)
if err != nil {
return err
}
}
return nil
}
func (c *Configuration) notifyCertificateRenewal(domain string, err error) {
if domain == "" {
domain = strings.Join(c.Domains, ",")
}
params := common.EventParams{
Name: domain,
Event: "Certificate renewal",
Timestamp: time.Now().UnixNano(),
}
if err != nil {
params.Status = 2
params.AddError(err)
} else {
params.Status = 1
}
common.HandleCertificateEvent(params)
}
func (c *Configuration) renewCertificates() error {
lockTime, err := c.getLockTime()
if err != nil {
return err
}
acmeLog(logger.LevelDebug, "certificate renew lock time %v", lockTime)
if lockTime.Add(-30*time.Second).Before(time.Now()) && lockTime.Add(5*time.Minute).After(time.Now()) {
acmeLog(logger.LevelInfo, "certificate renew skipped, lock time too close: %v", lockTime)
return nil
}
err = c.setLockTime()
if err != nil {
c.notifyCertificateRenewal("", err)
return err
}
account, client, err := c.setup()
if err != nil {
c.notifyCertificateRenewal("", err)
return err
}
if account.Registration == nil {
acmeLog(logger.LevelError, "cannot renew certificates, your account is not registered")
err = errors.New("cannot renew certificates, your account is not registered")
c.notifyCertificateRenewal("", err)
return err
}
var errRenew error
needReload := false
for _, domain := range c.Domains {
certificates, err := c.loadCertificatesForDomain(domain)
if err != nil {
c.notifyCertificateRenewal(domain, err)
errRenew = err
continue
}
cert := certificates[0]
if !c.needRenewal(cert, domain) {
continue
}
err = c.obtainAndSaveCertificate(client, domain)
if err != nil {
c.notifyCertificateRenewal(domain, err)
errRenew = err
} else {
c.notifyCertificateRenewal(domain, nil)
needReload = true
}
}
if needReload {
// at least one certificate has been renewed, sends a reload to all services that may be using certificates
err = ftpd.ReloadCertificateMgr()
acmeLog(logger.LevelInfo, "ftpd certificate manager reloaded , error: %v", err)
err = httpd.ReloadCertificateMgr()
acmeLog(logger.LevelInfo, "httpd certificates manager reloaded , error: %v", err)
err = webdavd.ReloadCertificateMgr()
acmeLog(logger.LevelInfo, "webdav certificates manager reloaded , error: %v", err)
err = telemetry.ReloadCertificateMgr()
acmeLog(logger.LevelInfo, "telemetry certificates manager reloaded , error: %v", err)
}
return errRenew
}
func isDomainValid(domain string) (string, bool) {
isValid := false
for _, d := range strings.Split(domain, ",") {
d = strings.TrimSpace(d)
if d != "" {
isValid = true
break
}
}
return domain, isValid
}
func sanitizedDomain(domain string) string {
return strings.NewReplacer(":", "_", "*", "_", ",", "_").Replace(domain)
}
func stopScheduler() {
if scheduler != nil {
scheduler.Stop()
scheduler = nil
}
}
func startScheduler() error {
stopScheduler()
rand.Seed(time.Now().UnixNano())
randSecs := rand.Intn(59)
scheduler = cron.New()
_, err := scheduler.AddFunc(fmt.Sprintf("@every 12h0m%ds", randSecs), renewCertificates)
if err != nil {
return fmt.Errorf("unable to schedule certificates renewal: %w", err)
}
acmeLog(logger.LevelInfo, "starting scheduler, initial certificates check in %d seconds", randSecs)
initialTimer := time.NewTimer(time.Duration(randSecs) * time.Second)
go func() {
<-initialTimer.C
renewCertificates()
}()
scheduler.Start()
return nil
}
func renewCertificates() {
if config != nil {
if err := config.renewCertificates(); err != nil {
acmeLog(logger.LevelError, "unable to renew certificates: %v", err)
}
}
}
func setLogMode(checkRenew bool) {
if checkRenew {
logMode = 1
} else {
logMode = 2
}
log.Logger = &logger.LegoAdapter{
LogToConsole: logMode != 1,
}
}
func acmeLog(level logger.LogLevel, format string, v ...any) {
if logMode == 1 {
logger.Log(level, logSender, "", format, v...)
} else {
switch level {
case logger.LevelDebug:
logger.DebugToConsole(format, v...)
case logger.LevelInfo:
logger.InfoToConsole(format, v...)
case logger.LevelWarn:
logger.WarnToConsole(format, v...)
default:
logger.ErrorToConsole(format, v...)
}
}
}