acme.go 26 KB

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