acme.go 27 KB

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