Merge pull request #1059 from PalmStoneGames/master

Add plugin capabilities for tls storage.

caddyhttp/caddyhttp_test.go

@@ -11,7 +11,7 @@ import (
 // ensure that the standard plugins are in fact plugged in
 // and registered properly; this is a quick/naive way to do it.
 func TestStandardPlugins(t *testing.T) {
-	numStandardPlugins := 25 // importing caddyhttp plugs in this many plugins
+	numStandardPlugins := 26 // importing caddyhttp plugs in this many plugins
 	s := caddy.DescribePlugins()
 	if got, want := strings.Count(s, "\n"), numStandardPlugins+5; got != want {
 		t.Errorf("Expected all standard plugins to be plugged in, got:\n%s", s)

caddytls/config.go

@@ -99,12 +99,10 @@ type Config struct {
 	// certificates
 	KeyType acme.KeyType
 
-	// The explicitly set storage creator or nil; use
+	// The storage creator; use StorageFor() to get a guaranteed
-	// StorageFor() to get a guaranteed non-nil Storage
+	// non-nil Storage instance. Note, Caddy may call this frequently
-	// instance. Note, Caddy may call this frequently so
+	// so implementors are encouraged to cache any heavy instantiations.
-	// implementors are encouraged to cache any heavy
+	StorageProvider string
-	// instantiations.
-	StorageCreator StorageCreator
 
 	// The state needed to operate on-demand TLS
 	OnDemandState OnDemandState
@@ -285,19 +283,20 @@ func (c *Config) StorageFor(caURL string) (Storage, error) {
 
 	// Create the storage based on the URL
 	var s Storage
-	if c.StorageCreator != nil {
+	if c.StorageProvider == "" {
-		s, err = c.StorageCreator(u)
+		c.StorageProvider = "file"
-		if err != nil {
-			return nil, fmt.Errorf("%s: unable to create custom storage: %v", caURL, err)
-		}
 	}
-	if s == nil {
+
-		// We trust that this does not return a nil s when there's a nil err
+	creator, ok := storageProviders[c.StorageProvider]
-		s, err = FileStorageCreator(u)
+	if !ok {
-		if err != nil {
+		return nil, fmt.Errorf("%s: Unknown storage: %v", caURL, c.StorageProvider)
-			return nil, fmt.Errorf("%s: unable to create file storage: %v", caURL, err)
-		}
 	}
+
+	s, err = creator(u)
+	if err != nil {
+		return nil, fmt.Errorf("%s: unable to create custom storage '%v': %v", caURL, c.StorageProvider, err)
+	}
+
 	return s, nil
 }
 

caddytls/config_test.go

@@ -38,11 +38,12 @@ func TestStorageForNoURL(t *testing.T) {
 
 func TestStorageForLowercasesAndPrefixesScheme(t *testing.T) {
 	resultStr := ""
+	RegisterStorageProvider("fake-TestStorageForLowercasesAndPrefixesScheme", func(caURL *url.URL) (Storage, error) {
+		resultStr = caURL.String()
+		return nil, nil
+	})
 	c := &Config{
-		StorageCreator: func(caURL *url.URL) (Storage, error) {
+		StorageProvider: "fake-TestStorageForLowercasesAndPrefixesScheme",
-			resultStr = caURL.String()
-			return nil, nil
-		},
 	}
 	if _, err := c.StorageFor("EXAMPLE.COM/BLAH"); err != nil {
 		t.Fatal(err)
@@ -71,11 +72,10 @@ func TestStorageForDefault(t *testing.T) {
 }
 
 func TestStorageForCustom(t *testing.T) {
-	storage := fakeStorage("fake")
+	storage := fakeStorage("fake-TestStorageForCustom")
+	RegisterStorageProvider("fake-TestStorageForCustom", func(caURL *url.URL) (Storage, error) { return storage, nil })
 	c := &Config{
-		StorageCreator: func(caURL *url.URL) (Storage, error) {
+		StorageProvider: "fake-TestStorageForCustom",
-			return storage, nil
-		},
 	}
 	s, err := c.StorageFor("example.com")
 	if err != nil {
@@ -87,10 +87,9 @@ func TestStorageForCustom(t *testing.T) {
 }
 
 func TestStorageForCustomError(t *testing.T) {
+	RegisterStorageProvider("fake-TestStorageForCustomError", func(caURL *url.URL) (Storage, error) { return nil, errors.New("some error") })
 	c := &Config{
-		StorageCreator: func(caURL *url.URL) (Storage, error) {
+		StorageProvider: "fake-TestStorageForCustomError",
-			return nil, errors.New("some error")
-		},
 	}
 	if _, err := c.StorageFor("example.com"); err == nil {
 		t.Fatal("Expecting error")
@@ -99,11 +98,7 @@ func TestStorageForCustomError(t *testing.T) {
 
 func TestStorageForCustomNil(t *testing.T) {
 	// Should fall through to the default
-	c := &Config{
+	c := &Config{StorageProvider: ""}
-		StorageCreator: func(caURL *url.URL) (Storage, error) {
-			return nil, nil
-		},
-	}
 	s, err := c.StorageFor("example.com")
 	if err != nil {
 		t.Fatal(err)

caddytls/filestorage.go

@@ -9,6 +9,10 @@ import (
 	"strings"
 )
 
+func init() {
+	RegisterStorageProvider("file", FileStorageCreator)
+}
+
 // storageBasePath is the root path in which all TLS/ACME assets are
 // stored. Do not change this value during the lifetime of the program.
 var storageBasePath = filepath.Join(caddy.AssetsPath(), "acme")

caddytls/setup.go

@@ -146,6 +146,16 @@ func setupTLS(c *caddy.Controller) error {
 					return c.Errf("Unsupported DNS provider '%s'", args[0])
 				}
 				config.DNSProvider = args[0]
+			case "storage":
+				args := c.RemainingArgs()
+				if len(args) != 1 {
+					return c.ArgErr()
+				}
+				storageProvName := args[0]
+				if _, ok := storageProviders[storageProvName]; !ok {
+					return c.Errf("Unsupported Storage provider '%s'", args[0])
+				}
+				config.StorageProvider = args[0]
 			default:
 				return c.Errf("Unknown keyword '%s'", c.Val())
 			}

caddytls/tls.go

@@ -168,3 +168,11 @@ var (
 	// when no other key type is specified.
 	DefaultKeyType = acme.RSA2048
 )
+
+var storageProviders = make(map[string]StorageCreator)
+
+// RegisterStorageProvider registers provider by name for storing tls data
+func RegisterStorageProvider(name string, provider StorageCreator) {
+	storageProviders[name] = provider
+	caddy.RegisterPlugin("tls.storage."+name, caddy.Plugin{})
+}