From 1340f13f95be4d3c6628dafbbb7ba3fd80cbcbe0 Mon Sep 17 00:00:00 2001
From: Brian Picciano <me@mediocregopher.com>
Date: Sun, 15 Dec 2024 21:39:41 +0100
Subject: [PATCH] Add ErrSecretNotFound and clarify other error-related docs

---
 go/daemon/daemon.go                   |  1 +
 go/daemon/network/errors.go           |  5 +++++
 go/daemon/network/network.go          |  8 ++++++++
 tasks/v0.0.3/code/audit-error-docs.md | 12 ------------
 4 files changed, 14 insertions(+), 12 deletions(-)
 delete mode 100644 tasks/v0.0.3/code/audit-error-docs.md

diff --git a/go/daemon/daemon.go b/go/daemon/daemon.go
index 633d91b..df9170f 100644
--- a/go/daemon/daemon.go
+++ b/go/daemon/daemon.go
@@ -115,6 +115,7 @@ func New(
 //
 // Errors:
 // - network.ErrInvalidConfig
+// - ErrAlreadyJoined
 func (d *Daemon) CreateNetwork(
 	ctx context.Context,
 	name, domain string, ipNet nebula.IPNet, hostName nebula.HostName,
diff --git a/go/daemon/network/errors.go b/go/daemon/network/errors.go
index 3327735..5959aa8 100644
--- a/go/daemon/network/errors.go
+++ b/go/daemon/network/errors.go
@@ -10,6 +10,7 @@ const (
 	errCodeInvalidConfig
 	errCodeHostNotFound
 	errCodeIPInUse
+	errCodeSecretNotFound
 )
 
 var (
@@ -30,4 +31,8 @@ var (
 	// ErrIPInUse is returned when performing an operation which was provided an
 	// IP already in use by another host in the network.
 	ErrIPInUse = jsonrpc2.NewError(errCodeIPInUse, "IP in use")
+
+	// ErrSecretNotFound is returned when a secret was required to perform some
+	// action, but the secret is not found in the secret store.
+	ErrSecretNotFound = jsonrpc2.NewError(errCodeSecretNotFound, "Secret not found")
 )
diff --git a/go/daemon/network/network.go b/go/daemon/network/network.go
index c00046c..3f2a495 100644
--- a/go/daemon/network/network.go
+++ b/go/daemon/network/network.go
@@ -85,6 +85,7 @@ type RPC interface {
 	// Errors:
 	// - ErrIPInUse - if IP field of CreateHostOpts is given, and already in use
 	//   by another host in the network.
+	// - ErrSecretNotFound - This Network doesn't have the CA signing key.
 	CreateHost(
 		context.Context, nebula.HostName, CreateHostOpts,
 	) (
@@ -97,6 +98,7 @@ type RPC interface {
 	//
 	// Errors:
 	// - ErrHostNotFound
+	// - ErrSecretNotFound - This Network doesn't have the CA signing key.
 	CreateNebulaCertificate(
 		context.Context, nebula.HostName, nebula.EncryptingPublicKey,
 	) (
@@ -907,6 +909,9 @@ func (n *network) CreateHost(
 		ctx, n.secretsStore,
 	)
 	if err != nil {
+		if errors.Is(err, secrets.ErrNotFound) {
+			err = ErrSecretNotFound
+		}
 		return JoiningBootstrap{}, fmt.Errorf("getting CA signing key: %w", err)
 	}
 
@@ -977,6 +982,9 @@ func (n *network) CreateNebulaCertificate(
 			ctx, n.secretsStore,
 		)
 		if err != nil {
+			if errors.Is(err, secrets.ErrNotFound) {
+				err = ErrSecretNotFound
+			}
 			return nebula.Certificate{}, fmt.Errorf("getting CA signing key: %w", err)
 		}
 
diff --git a/tasks/v0.0.3/code/audit-error-docs.md b/tasks/v0.0.3/code/audit-error-docs.md
deleted file mode 100644
index e73d43f..0000000
--- a/tasks/v0.0.3/code/audit-error-docs.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-type: task
----
-
-# Audit Error Code Documentation
-
-Audit all code for RPC methods in both `daemon` and `daemon/network`, ensuring
-that all error codes which can be returned are properly documented, and that all
-errors which should have an error code have one.
-
-`CreateNebulaCertificate` should return a specific error for if the CA root key
-secret couldn't be found.