Skip to content

Pandora CLI

Pandora CLI is an HTTPS client tool designed to provide a simple and intuitive interface for interacting with the Pandora Secrets Management System. It allows users to perform all necessary actions related to the Pandora server through a command-line interface.

main.go
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package main

import (
    "fmt"
    "github.com/spf13/cobra"
    "os"
)

type Config struct {
    URL          string `yaml:"url"`
    RootUsername string `yaml:"root_username"`
    RootPassword string `yaml:"root_password"`
    Username     string `yaml:"username"`
    Password     string `yaml:"password"`
    PrivateKey   string `yaml:"private_key"`
    PublicKey    string `yaml:"public_key"`
}

var (
    cfg Config
)

func main() {

    rootCmd := &cobra.Command{Use: "pandora-client"}
    loc := getExecutableLocation()
    loadConfig(fmt.Sprintf("%s/config.yaml", loc))
    // Add "secret" and "user" commands to the root command
    rootCmd.AddCommand(SecretCmd(), UserCmd())

    // Execute the root command
    if err := rootCmd.Execute(); err != nil {
        fmt.Println(err)
        os.Exit(1)
    }
}

User Guide

Prerequisites

  • Golang installed on the machine to compile the code.

Installation

  1. Clone the repository: 
    git clone https://github.com/MustafaAbdulazizHamza/Pandora-CLI.git
  2. Generate or obtain your own RSA key pair (key.pem files).
  3. Compile the code: 
    go build -o pandora-cli
  4. Edit the configuration file with your credentials. Leave the root credentials blank if you are not the root user.
  5. Run the compiled executable. You can move it to any location, but ensure that the configuration file remains in the same directory as the executable.

User Management

User management is a crucial part of any system. In Pandora, user management is primarily handled by the root user, with some exceptions allowing individual users to update their own passwords. 1. To add a new user: 

pandora-cli user add -u username1 -p password1
2. To update user credentials: 
pandora-cli user update -u username1 -p password2
3. To delete a user: 
pandora-cli user delete -u username1

Secret Management

Pandora was initially developed as a secrets management system, with its primary responsibility being to allow users to securely add, retrieve, update, and delete their secrets in a centralized manner through simple API calls. 1. To add a secret: 

pandora-cli secret add -i secret_id -s secret1
2. To retrieve a secret: 
pandora-cli secret get -i secret_id
3. To update a secret: 
pandora-cli secret update -i secret_id -s secret2
4. To delete a secret: 
pandora-cli delete -i secret_id

GitHub