add charset modifier to secret generation #521

2025-03-17T17:15:13Z

Apfelwurm commented

2025-03-17 17:15:13 +00:00

since we need special chars in passwords for a recipe we are working on, i have added the option to specify a charset in the same way as the length can be setted.
i did not change anything in the behaviour, so if length is not specified, the charset gets ignored whether it is there or not.

you can specify the following:
charset=default - Results in passgen.AlphabetDefault being used
charset=special - Results in passgen.AlphabetSpecial being used
charset=safespecial - Results in !@#%^&*_-+= being used (so it is AlphabetSpecial without the dollar sign)
charset=default,special or charset=special,default - Results in passgen.AlphabetDefault + passgen.AlphabetSpecial being used
charset=default,safespecial or charset=safespecial,default - Results in passgen.AlphabetDefault + !@#%^&*_-+= being used ((so it is AlphabetSpecial without the dollar sign)

Also added the charset testing to TestReadSecretsConfig. I thought about implementing tests for the generation itself, but did not really come up with something that made sense for me.

As i'm not that familiar with go, this might need to be reviewed carefully and might need additional work.
Edit: PR for the docs: toolshed/docs.coopcloud.tech#271

since we need special chars in passwords for a recipe we are working on, i have added the option to specify a charset in the same way as the length can be setted. i did not change anything in the behaviour, so if length is not specified, the charset gets ignored whether it is there or not. you can specify the following: `charset=default` - Results in passgen.AlphabetDefault being used `charset=special` - Results in passgen.AlphabetSpecial being used `charset=safespecial` - Results in `!@#%^&*_-+=` being used (so it is AlphabetSpecial without the dollar sign) `charset=default,special` or `charset=special,default` - Results in passgen.AlphabetDefault + passgen.AlphabetSpecial being used `charset=default,safespecial` or `charset=safespecial,default` - Results in passgen.AlphabetDefault + `!@#%^&*_-+=` being used ((so it is AlphabetSpecial without the dollar sign) Also added the charset testing to TestReadSecretsConfig. I thought about implementing tests for the generation itself, but did not really come up with something that made sense for me. As i'm not that familiar with go, this might need to be reviewed carefully and might need additional work. Edit: PR for the docs: https://git.coopcloud.tech/toolshed/docs.coopcloud.tech/pulls/271

❤️ 3

Apfelwurm referenced this pull request from toolshed/docs.coopcloud.tech

2025-03-17 18:41:41 +00:00

add secret generation characters modifier to maintainers handbook #271

p4u1 approved these changes 2025-03-18 07:45:41 +00:00

Dismissed

pkg/secret/secret.go Outdated

						
				@@ -45,3 +49,3 @@

				// GeneratePasswords generates passwords.

				func GeneratePasswords(count, length uint) ([]string, error) {

				func GeneratePasswords(count, length uint, charset string) ([]string, error) {

p4u1 commented

2025-03-18 07:43:45 +00:00

I think GeneratePasswords is only used with count=1. If you are up for it, a seperate refactor commit would be nice, that changes the function to GeneratePassword(length uint, charset string) (string, error)

(Same for GeneratePassphrases)

I think GeneratePasswords is only used with `count=1`. If you are up for it, a seperate refactor commit would be nice, that changes the function to `GeneratePassword(length uint, charset string) (string, error)` (Same for `GeneratePassphrases`)

👍 1

Apfelwurm commented

2025-03-18 11:33:34 +00:00

done :)

Apfelwurm marked this conversation as resolved

pkg/secret/secret.go Outdated

						
				@@ -152,1 +156,4 @@

							}

							charset := modifierValues["charset"]

							value.Charset = resolveCharset(charset)

p4u1 commented

2025-03-18 07:40:31 +00:00

This can be combined into one line

👍 1

decentral1se commented

2025-03-18 08:13:03 +00:00

Is "charset" guaranteed to be present? Otherwise, you might want to do the presence check of the key and otherwise supply a default.

Is `"charset"` guaranteed to be present? Otherwise, you might want to do the presence check of the key and otherwise supply a default.

👍 1

p4u1 commented

2025-03-18 09:18:50 +00:00

It retuens an empty string when not present, which is handled in resolveCharset. SO for me its fine to not check for the presence

It retuens an empty string when not present, which is handled in `resolveCharset`. SO for me its fine to not check for the presence

👍 2

Apfelwurm commented

2025-03-18 11:33:56 +00:00

done :)

Apfelwurm marked this conversation as resolved

decentral1se commented

2025-03-18 08:13:19 +00:00

Really Cool ™

👍 1 ❤️ 1

Apfelwurm force-pushed feature/special_charset_secret_generation from 4795c4d732 to d3c9c39f13

2025-03-18 11:32:58 +00:00

Compare

Apfelwurm requested review from p4u1 2025-03-18 12:18:36 +00:00

p4u1 reviewed 2025-03-21 07:59:55 +00:00

pkg/secret/secret.go Outdated

						
				@@ -61,3 +65,3 @@

				// GeneratePassphrases generates human readable and rememberable passphrases.

				func GeneratePassphrases(count uint) ([]string, error) {

				func GeneratePassphrases() ([]string, error) {

p4u1 commented

2025-03-21 07:59:54 +00:00

the return type could also be changed to (string, error)

the return type could also be changed to `(string, error)`

❤️ 1

Apfelwurm commented

2025-03-21 08:31:22 +00:00

done, also changed the name to fit the single generation

Apfelwurm marked this conversation as resolved

p4u1 reviewed 2025-03-21 08:00:05 +00:00

pkg/secret/secret.go Outdated

						
				@@ -44,11 +48,11 @@ type Secret struct {

				}

				// GeneratePasswords generates passwords.

				func GeneratePasswords(count, length uint) ([]string, error) {