acme.go 23 KB

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