Skip to contentSkip to conversation

Allow config to read private key from file

PATCH Superseded Daniel Gröber 2 participants 3 messages Nov 20, 2022 – Nov 21, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Allow config to read private key from file

This adds a new config key PrivateKeyFile= that simply hooks up the existing code for the wg set ... private-key /file codepath.

Using this new option the interface configs can be much easier to deploy in an automated fashion as they don't contain secrets anymore. The private key can easily be provisioned out of band or using a one-time provisioning step instead.

Before this patch we were using a neat hack: it's possible to simply omit PrivateKey= and set it using PostUp= wg set %i private-key /some/file. However this breaks when we try to use setconf or synconf as they will (rightly) unset the private key instead of leaving it as-is.

---
 src/config.c | 4 ++++
 src/man/wg.8 | 2 ++
 2 files changed, 6 insertions(+)
src/config.c +4 -0
index e8db900..49cbb07 100644
@@ -464,6 +464,10 @@ static bool process_line(struct config_ctx *ctx, const char *line)
 			ret = parse_key(ctx->device->private_key, value);
 			if (ret)
 				ctx->device->flags |= WGDEVICE_HAS_PRIVATE_KEY;
+		} else if (key_match("PrivateKeyFile")) {
+			ret = parse_keyfile(ctx->device->private_key, value);
+			if (ret)
+				ctx->device->flags |= WGDEVICE_HAS_PRIVATE_KEY;
 		} else
 			goto error;
 	} else if (ctx->is_peer_section) {
src/man/wg.8 +2 -0
index fd9fde7..1d37338 100644
@@ -134,6 +134,8 @@ The \fIInterface\fP section may contain the following fields:
 .IP \(bu
 PrivateKey \(em a base64 private key generated by \fIwg genkey\fP. Required.
 .IP \(bu
+PrivateKeyFile \(em path to a file containing base64 private key. May be used instead of \fIPrivateKey\fP. Optional.
+.IP \(bu
 ListenPort \(em a 16-bit port for listening. Optional; if not specified, chosen
 randomly.
 .IP \(bu
Signature · 1 line
2.30.2
#1 lore raw
Quoted 7 lines · Daniel Gröber

This adds a new config key PrivateKeyFile= that simply hooks up the existing code for the wg set ... private-key /file codepath.

Using this new option the interface configs can be much easier to deploy in an automated fashion as they don't contain secrets anymore. The private key can easily be provisioned out of band or using a one-time provisioning step instead.

This is definitely a very welcome option in my PoV.

Add my

for this.

Quoted 2 lines

Before this patch we were using a neat hack: it's possible to simply omit PrivateKey= and set it using PostUp= wg set %i private-key /some/file.

Well, this isn't really neat, it is a hackish workaround for the missing functionality ;)

On a side, note, almost a year ago I sent a patch for wg utility to recognize and discard some keywords which are processed by wg-quick script - like, Address=. This way, there's no need to pre-process the config file anymore, and in order to recognize more peers, one doesn't have to restart the tunnel interface, instead, a regular wg syncconf wgif.conf is sufficient, and many things can be simplified too (removing the preprocessing). I've never got any reply for these patches.

/mjt

#2 lore raw

Hi Michael,

Quoted 10 lines · Michael Tokarev
Quoted 4 lines · Daniel Gröber

Using this new option the interface configs can be much easier to deploy in an automated fashion as they don't contain secrets anymore. The private key can easily be provisioned out of band or using a one-time provisioning step instead.

This is definitely a very welcome option in my PoV.

Add my

I think you mean Reviewed-By? Speaking of which I actually forgot the signoff myself. Doh.

Is Reviewed-By something we do here? I can't find a single such tag with git log --grep Reviewed-By. I appreciate the positive response nontheless though :)

Quoted 5 lines
Quoted 2 lines

Before this patch we were using a neat hack: it's possible to simply omit PrivateKey= and set it using PostUp= wg set %i private-key /some/file.

Well, this isn't really neat, it is a hackish workaround for the missing functionality ;)

It does work surprisingly well though :D. I just re-set the private-key after syncconf now, which definetly ought to loose some traffic but it works at least ;)

Quoted 6 lines

On a side, note, almost a year ago I sent a patch for wg utility to recognize and discard some keywords which are processed by wg-quick script - like, Address=. This way, there's no need to pre-process the config file anymore, and in order to recognize more peers, one doesn't have to restart the tunnel interface, instead, a regular wg syncconf wgif.conf is sufficient, and many things can be simplified too (removing the preprocessing).

Ok I think I found your patch[1]. So we did actually independently come up with the idea of PrivateKeyFile, interesting. Also you support PresharedKey too. I realised I forgot that one right after sending the patch obv. ;) I'll send a v2 for that soon.

[1]: https://lists.zx2c4.com/pipermail/wireguard/2021-January/006346.html

As for ignoring the wg-quick options, I'm not sure what's the right way to go there. I don't find the wg-quick strip approach toooo taxing but it sure would be more convenient to just call one tool.

Quoted 1 line

I've never got any reply for these patches.

I have another patch pending for a longish while aswell "wg: Support restricting address family of DNS resolved Endpoint". IMO you should have just resent your series every couple of months :)

--Daniel