2023-07-29 10:59:24 +00:00
|
|
|
// Package webroot implements an HTTP provider for solving the HTTP-01 challenge using web server's root path.
|
2019-03-11 16:56:48 +00:00
|
|
|
package webroot
|
2016-02-10 11:19:29 +00:00
|
|
|
|
|
|
|
import (
|
2020-02-27 18:14:46 +00:00
|
|
|
"errors"
|
2016-02-10 11:19:29 +00:00
|
|
|
"fmt"
|
|
|
|
"os"
|
2018-09-11 22:41:30 +00:00
|
|
|
"path/filepath"
|
2016-03-14 10:49:02 +00:00
|
|
|
|
2020-09-02 01:20:01 +00:00
|
|
|
"github.com/go-acme/lego/v4/challenge/http01"
|
2016-02-10 11:19:29 +00:00
|
|
|
)
|
|
|
|
|
2020-05-08 17:35:25 +00:00
|
|
|
// HTTPProvider implements ChallengeProvider for `http-01` challenge.
|
2016-03-16 10:32:09 +00:00
|
|
|
type HTTPProvider struct {
|
2016-02-10 11:19:29 +00:00
|
|
|
path string
|
|
|
|
}
|
|
|
|
|
2020-05-08 17:35:25 +00:00
|
|
|
// NewHTTPProvider returns a HTTPProvider instance with a configured webroot path.
|
2016-03-16 10:32:09 +00:00
|
|
|
func NewHTTPProvider(path string) (*HTTPProvider, error) {
|
2016-02-10 15:55:10 +00:00
|
|
|
if _, err := os.Stat(path); os.IsNotExist(err) {
|
2020-02-27 18:14:46 +00:00
|
|
|
return nil, errors.New("webroot path does not exist")
|
2016-02-10 15:55:10 +00:00
|
|
|
}
|
|
|
|
|
2018-09-24 19:07:20 +00:00
|
|
|
return &HTTPProvider{path: path}, nil
|
2016-02-10 15:55:10 +00:00
|
|
|
}
|
|
|
|
|
2020-05-08 17:35:25 +00:00
|
|
|
// Present makes the token available at `HTTP01ChallengePath(token)` by creating a file in the given webroot path.
|
2016-03-16 10:32:09 +00:00
|
|
|
func (w *HTTPProvider) Present(domain, token, keyAuth string) error {
|
2016-02-10 11:19:29 +00:00
|
|
|
var err error
|
2016-02-10 15:55:10 +00:00
|
|
|
|
2018-12-06 21:50:17 +00:00
|
|
|
challengeFilePath := filepath.Join(w.path, http01.ChallengePath(token))
|
2020-07-09 23:48:18 +00:00
|
|
|
err = os.MkdirAll(filepath.Dir(challengeFilePath), 0o755)
|
2016-02-10 15:55:10 +00:00
|
|
|
if err != nil {
|
2020-03-20 21:53:09 +00:00
|
|
|
return fmt.Errorf("could not create required directories in webroot for HTTP challenge: %w", err)
|
2016-02-10 15:55:10 +00:00
|
|
|
}
|
|
|
|
|
2021-08-25 09:44:11 +00:00
|
|
|
err = os.WriteFile(challengeFilePath, []byte(keyAuth), 0o644)
|
2016-02-10 11:19:29 +00:00
|
|
|
if err != nil {
|
2020-03-20 21:53:09 +00:00
|
|
|
return fmt.Errorf("could not write file in webroot for HTTP challenge: %w", err)
|
2016-02-10 11:19:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2020-05-08 17:35:25 +00:00
|
|
|
// CleanUp removes the file created for the challenge.
|
2016-03-16 10:32:09 +00:00
|
|
|
func (w *HTTPProvider) CleanUp(domain, token, keyAuth string) error {
|
2018-12-06 21:50:17 +00:00
|
|
|
err := os.Remove(filepath.Join(w.path, http01.ChallengePath(token)))
|
2016-02-10 11:19:29 +00:00
|
|
|
if err != nil {
|
2020-03-20 21:53:09 +00:00
|
|
|
return fmt.Errorf("could not remove file in webroot after HTTP challenge: %w", err)
|
2016-02-10 11:19:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|