Add user private keys management commands: add, delete #304

piotr-andruszkiewicz-wttech · 2025-05-26T20:28:56Z

$ ./bin/aem auth user --help
User management

Usage:
  aem auth user [command]

Aliases:
  user, usr

Available Commands:
  key         Private keys management
  keystore    Keystore management
  password    Password management

Flags:
  -h, --help   help for user

$ ./bin/aem auth user key --help
Private keys management

Usage:
  aem auth user key [command]

Aliases:
  key, keys

Available Commands:
  add         Add user's private key to their keystore
  delete      Delete user's private key from their keystore

Flags:
  -h, --help   help for key
  
$ ./bin/aem auth user key add --help
Add user's private key to their keystore

Usage:
  aem auth user key add [flags]

Aliases:
  add, create, new

Flags:
  -h, --help                       help for add
      --id string                  user id
      --key-alias string           key alias
      --key-password string        key password
      --keystore-file string       path to keystore file
      --keystore-password string   keystore password
      --new-alias string           new key alias (optional)
      --scope string               user scope

$ ./bin/aem auth user key rm --help
Delete user's private key from their keystore

Usage:
  aem auth user key delete [flags]

Aliases:
  delete, remove, rm

Flags:
  -h, --help               help for delete
      --id string          user id
      --key-alias string   key alias
      --scope string       user scope

$ ./bin/aem auth user key add --scope we-retail --id DSCP-athB1NYLBXvdTuN -A  --key-alias test-alias --keystore-file ~/Downloads/test.keystore --keystore-password abcd
INFO[2025-05-27 11:21:34] User key added             

$ ./bin/aem auth user key add --scope we-retail --id DSCP-athB1NYLBXvdTuN -A  --key-alias test-alias --keystore-file ~/Downloads/test.keystore --keystore-password abcd
INFO[2025-05-27 11:21:36] User key already exists    

$ ./bin/aem auth user key rm --scope we-retail --id DSCP-athB1NYLBXvdTuN -A --key-alias test-alias
INFO[2025-05-27 11:21:46] User key deleted           

$ ./bin/aem auth user key rm --scope we-retail --id DSCP-athB1NYLBXvdTuN -A --key-alias test-alias
INFO[2025-05-27 11:21:47] User key does not exist

krystian-panek-vmltech · 2025-05-27T07:11:18Z

cmd/aem/user.go

+func (c *CLI) KeystoreKeyAdd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "add",
+		Short:   "Create user Keystore key",


"masło maślane" a bit :)

do not mix upper case with lowercase; make it looking elegant / consistent

krystian-panek-vmltech · 2025-05-27T07:13:31Z

cmd/aem/user.go

+				return
+			}
+
+			changed, err := instance.Auth().UserManager().DeleteKeystoreKey(


commands are scoped so keystore keys should be also scoped

UserManager().Keystore().DeleteKey() ?

krystian-panek-vmltech · 2025-05-27T07:15:03Z

pkg/user_manager.go

 	return UsersPath + "/" + scope + "/" + id
 }
+
+func readKeyStore(filename string, password []byte) (*jks.KeyStore, error) {


why are we reading this?

Because what we get from AEM when something is wrong with the keystore is a 500 response with HTML document. I wanted to check the keystore locally so we get more info rather than parsing the response.

krystian-panek-vmltech · 2025-05-27T07:15:38Z

pkg/user_manager.go

+	}
+
+	if status == nil || !status.Created {
+		return false, fmt.Errorf("%s > cannot add keystore key: keystore does not exist", um.instance.IDColor())


cannot add keystore key as keystore does not exist ? ( i mean merge msg)

krystian-panek-vmltech · 2025-05-27T07:16:06Z

pkg/user_manager.go

+		"keyStore": keystoreFilePath,
+	}
+
+	keystorePath := assembleUserPath(scope, id) + ".ks.html"


composeUserPath

stubborn 😉

…s own command

… and improve structure

krystian-panek-vmltech · 2025-05-27T09:43:43Z

cmd/aem/user.go

 	cmd := &cobra.Command{
 		Use:     "status",
-		Short:   "Get status of keystore",
+		Short:   "Get status of a user's keystore",


just user keystore ? :)

krystian-panek-vmltech · 2025-05-27T09:44:03Z

cmd/aem/user.go

+func (c *CLI) userKeyAdd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "add",
+		Short:   "Add user's private key to their keystore",


just user private key

krystian-panek-vmltech · 2025-05-27T09:44:37Z

pkg/keystore/keystore_status.go

keystore/{keystore_status => status}.go

krystian-panek-vmltech · 2025-05-27T09:45:37Z

pkg/keystore_manager.go

+}
+
+func (km *KeystoreManager) Status(scope, id string) (*keystore.Status, error) {
+	userKeystorePath := composeUserPath(scope, id) + ".ks.json"


you are appending ".ks.json" here and on line 52 as well ; extract same func or sth

…checkout actions

…e readKeyStore function

Piotr Andruszkiewicz added 2 commits May 26, 2025 21:02

Add user private keys management commands: add, delete

546a23e

Refactor Keystore methods: remove code repetitions

89283a7

piotr-andruszkiewicz-wttech requested a review from krystian-panek-vmltech May 26, 2025 20:28

krystian-panek-vmltech reviewed May 27, 2025

View reviewed changes

Piotr Andruszkiewicz added 3 commits May 27, 2025 11:24

Refactor user command structure: separate user key management into it…

2384789

…s own command

Refactor UserManager and KeystoreManager: streamline keystore methods…

3afa3a8

… and improve structure

Fix capitalization in keystore and key management messages

7ede2e4

krystian-panek-vmltech reviewed May 27, 2025

View reviewed changes

pkg/keystore/keystore_status.go

Copy link

Contributor

krystian-panek-vmltech May 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keystore/{keystore_status => status}.go

krystian-panek-vmltech reviewed May 27, 2025

View reviewed changes

krystian-panek-vmltech approved these changes May 27, 2025

View reviewed changes

Piotr Andruszkiewicz added 6 commits May 27, 2025 11:52

Fix capitalization in keystore command descriptions

4dabdca

Rename files for conciseness

7f18fed

Update GitHub Actions to use latest versions of cache, setup-go, and …

0389721

…checkout actions

Update Go version to 1.24 in workflows and go.mod

967dd39

Refactor CLI and project package imports; streamline logging messages

edfd649

Refactor keystore management: streamline path composition and relocat…

9ad92cf

…e readKeyStore function

piotr-andruszkiewicz-wttech merged commit 9fc43a1 into main May 27, 2025
1 check passed

Add user private keys management commands: add, delete #304

Add user private keys management commands: add, delete #304

Uh oh!

Conversation

piotr-andruszkiewicz-wttech commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krystian-panek-vmltech May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

piotr-andruszkiewicz-wttech commented May 26, 2025 •

edited

Loading

krystian-panek-vmltech May 27, 2025 •

edited

Loading