acme.go 26 KB

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