Add #37 add verbose v006 (#41)

* Added logger to httpjson package

* Create logger interface and implement interface for CMD logging

* When init pas client also init with logger depending on --verbose flag

* Add logger to the PAS apis

* Do not log added account password. Implemented secrets in logger that will be scrubed when logging

* Scrub the password by creating a new logger with secrets

cmd/accounts.go

@@ -76,7 +76,7 @@ var listAccountsCmd = &cobra.Command{
 	Example Usage:
 	$ cybr accounts list`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -109,7 +109,7 @@ var getAccountsCmd = &cobra.Command{
 	Example Usage:
 	$ cybr accounts get -i 24_1`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -165,7 +165,7 @@ var addAccountsCmd = &cobra.Command{
 	Example Usage:
 	$ cybr accounts add -s SafeName -p platformID -u username -a 10.0.0.1 -t password -s SuperSecret`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -209,7 +209,7 @@ var deleteAccountsCmd = &cobra.Command{
 	Example Usage:
 	$ cybr accounts delete 24_1`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return

cmd/applications.go

@@ -65,7 +65,7 @@ var listApplicationsCmd = &cobra.Command{
 	$ cybr applications list`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -91,7 +91,7 @@ var listMethodsCmd = &cobra.Command{
 	$ cybr applications list-authn -a AppID`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -115,7 +115,7 @@ var addApplicationCmd = &cobra.Command{
 	Example Usage:
 	$ cybr applications add -a AppID -l "\\"`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -155,7 +155,7 @@ var deleteApplicationCmd = &cobra.Command{
 	Example Usage:
 	$ cybr applications delete -a AppID`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -179,7 +179,7 @@ var addApplicationAuthenticationMethodCmd = &cobra.Command{
 	Example Usage:
 	$ cybr applications add-authn -a AppID -t path -v /some/path`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -212,7 +212,7 @@ var deleteApplicationAuthenticationMethodCmd = &cobra.Command{
 	Example Usage:
 	$ cybr applications delete-authn -a AppID -i 1`,
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return

cmd/logoff.go

@@ -17,7 +17,7 @@ var logoffCmd = &cobra.Command{
 	$ cybr logoff`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 		}

cmd/root.go

@@ -4,11 +4,17 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/infamousjoeg/cybr-cli/pkg/logger"
 	"github.com/spf13/cobra"
 )
 
 var cfgFile string
 
+var (
+	// Verbose logging
+	Verbose bool
+)
+
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "cybr",
@@ -28,7 +34,16 @@ func Execute() {
 	}
 }
 
+func getLogger() logger.CMD {
+	return logger.CMD{
+		LoggerEnabled:    Verbose,
+		LogHeaderEnabled: true,
+		LogBodyEnabled:   true,
+	}
+}
+
 func init() {
+	rootCmd.PersistentFlags().BoolVar(&Verbose, "verbose", false, "To enable verbose logging")
 	// cobra.OnInitialize(initConfig)
 
 	// Here you will define your flags and configuration settings.

cmd/safes.go

@@ -94,7 +94,7 @@ var listSafesCmd = &cobra.Command{
 	$ cybr safes list`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -121,7 +121,7 @@ var listMembersCmd = &cobra.Command{
 	Aliases: []string{"list-member"},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -147,7 +147,7 @@ var addMembersCmd = &cobra.Command{
 	$ cybr safes add-member -s SafeName -m MemberName --retrieve-account`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -251,7 +251,7 @@ var removeMembersCmd = &cobra.Command{
 	$ cybr safes remove-member -s SafeName -m MemberName`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -278,7 +278,7 @@ var addSafeCmd = &cobra.Command{
 	$ cybr safes add -s SafeName -d Description --cpm ManagingCPM --days 0`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -314,7 +314,7 @@ var deleteSafeCmd = &cobra.Command{
 	$ cybr safes delete -s SafeName`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return
@@ -339,7 +339,7 @@ var updateSafeCmd = &cobra.Command{
 	$ cybr safes update -t TargetSafeName -s NewSafeName -d NewDesc`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Get config file written to local file system
-		client, err := pasapi.GetConfig()
+		client, err := pasapi.GetConfigWithLogger(getLogger())
 		if err != nil {
 			log.Fatalf("Failed to read configuration file. %s", err)
 			return

pkg/cybr/api/accounts.go

@@ -62,7 +62,7 @@ type AddAccountRequest struct {
 // ListAccounts CyberArk user has access to
 func (c Client) ListAccounts(query *ListAccountQueryParams) (*ListAccountResponse, error) {
 	url := fmt.Sprintf("%s/PasswordVault/api/Accounts%s", c.BaseURL, httpJson.GetURLQuery(query))
-	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		return &ListAccountResponse{}, fmt.Errorf("Failed to list accounts. %s", err)
 	}
@@ -76,7 +76,7 @@ func (c Client) ListAccounts(query *ListAccountQueryParams) (*ListAccountRespons
 // GetAccount details for specific account
 func (c Client) GetAccount(accountID string) (*GetAccountResponse, error) {
 	url := fmt.Sprintf("%s/PasswordVault/api/Accounts/%s", c.BaseURL, accountID)
-	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		return &GetAccountResponse{}, fmt.Errorf("Failed to get account. %s", err)
 	}
@@ -90,7 +90,10 @@ func (c Client) GetAccount(accountID string) (*GetAccountResponse, error) {
 // AddAccount to cyberark
 func (c Client) AddAccount(account AddAccountRequest) (*GetAccountResponse, error) {
 	url := fmt.Sprintf("%s/PasswordVault/api/Accounts", c.BaseURL)
-	response, err := httpJson.Post(url, c.SessionToken, account, c.InsecureTLS)
+	logger := c.Logger.AddSecret(account.Secret)
+	response, err := httpJson.Post(url, c.SessionToken, account, c.InsecureTLS, logger)
+	logger = logger.ClearSecrets()
+
 	if err != nil {
 		returnedError, _ := json.Marshal(response)
 		return &GetAccountResponse{}, fmt.Errorf("Failed to add account. %s. %s", string(returnedError), err)
@@ -105,7 +108,7 @@ func (c Client) AddAccount(account AddAccountRequest) (*GetAccountResponse, erro
 // DeleteAccount from cyberark
 func (c Client) DeleteAccount(accountID string) error {
 	url := fmt.Sprintf("%s/PasswordVault/api/Accounts/%s", c.BaseURL, accountID)
-	response, err := httpJson.Delete(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Delete(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		returnedError, _ := json.Marshal(response)
 		return fmt.Errorf("Failed to delete account '%s'. %s. %s", accountID, string(returnedError), err)

pkg/cybr/api/applications.go

@@ -33,7 +33,7 @@ type ListApplication struct {
 // ListApplications returns all Application Identities setup in PAS
 func (c Client) ListApplications(location string) (*ListApplicationsResponse, error) {
 	url := fmt.Sprintf("%s/PasswordVault/WebServices/PIMServices.svc/Applications?Location=%s", c.BaseURL, location)
-	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		return &ListApplicationsResponse{}, fmt.Errorf("Error listing applications in location '%s'. %s", location, err)
 	}
@@ -62,7 +62,7 @@ type ListAuthentication struct {
 // ListApplicationAuthenticationMethods returns all auth methods for a specific Application Identity
 func (c Client) ListApplicationAuthenticationMethods(appID string) (*ListApplicationAuthenticationMethodsResponse, error) {
 	url := fmt.Sprintf("%s/PasswordVault/WebServices/PIMServices.svc/Applications/%s/Authentications", c.BaseURL, appID)
-	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Get(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		return &ListApplicationAuthenticationMethodsResponse{}, fmt.Errorf("Error listing application's '%s' authentication methods. %s", appID, err)
 	}
@@ -95,7 +95,7 @@ type Application struct {
 // AddApplication add an applications to PAS
 func (c Client) AddApplication(application AddApplicationRequest) error {
 	url := fmt.Sprintf("%s/PasswordVault/WebServices/PIMServices.svc/Applications", c.BaseURL)
-	response, err := httpJson.Post(url, c.SessionToken, application, c.InsecureTLS)
+	response, err := httpJson.Post(url, c.SessionToken, application, c.InsecureTLS, c.Logger)
 	if err != nil {
 		returnedError, _ := json.Marshal(response)
 		return fmt.Errorf("Error adding application '%s' authentication methods. %s. %s", application.Application.AppID, string(returnedError), err)
@@ -106,7 +106,7 @@ func (c Client) AddApplication(application AddApplicationRequest) error {
 // DeleteApplication delete an applications to PAS
 func (c Client) DeleteApplication(appID string) error {
 	url := fmt.Sprintf("%s/PasswordVault/WebServices/PIMServices.svc/Applications/%s", c.BaseURL, url.QueryEscape(appID))
-	response, err := httpJson.Delete(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Delete(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		returnedError, _ := json.Marshal(response)
 		return fmt.Errorf("Error deleting application '%s' authentication methods. %s. %s", appID, string(returnedError), err)
@@ -130,7 +130,7 @@ type ApplicationAuthenticationMethod struct {
 // AddApplicationAuthenticationMethod add authentication method to an application
 func (c Client) AddApplicationAuthenticationMethod(appID string, authenticationMethod AddApplicationAuthenticationRequest) error {
 	url := fmt.Sprintf("%s/PasswordVault/WebServices/PIMServices.svc/Applications/%s/Authentications/", c.BaseURL, url.QueryEscape(appID))
-	response, err := httpJson.Post(url, c.SessionToken, authenticationMethod, c.InsecureTLS)
+	response, err := httpJson.Post(url, c.SessionToken, authenticationMethod, c.InsecureTLS, c.Logger)
 	if err != nil {
 		returnedError, _ := json.Marshal(response)
 		return fmt.Errorf("Error adding application authentication method to '%s'. %s. %s", appID, string(returnedError), err)
@@ -141,7 +141,7 @@ func (c Client) AddApplicationAuthenticationMethod(appID string, authenticationM
 // DeleteApplicationAuthenticationMethod delete an applications authentication method
 func (c Client) DeleteApplicationAuthenticationMethod(appID string, authnMethodID string) error {
 	url := fmt.Sprintf("%s/PasswordVault/WebServices/PIMServices.svc/Applications/%s/Authentications/%s", c.BaseURL, url.QueryEscape(appID), url.QueryEscape(authnMethodID))
-	response, err := httpJson.Delete(url, c.SessionToken, c.InsecureTLS)
+	response, err := httpJson.Delete(url, c.SessionToken, c.InsecureTLS, c.Logger)
 	if err != nil {
 		returnedError, _ := json.Marshal(response)
 		return fmt.Errorf("Error deleting application '%s' authentication methods. %s. %s", appID, string(returnedError), err)

pkg/cybr/api/auth.go

@@ -24,7 +24,7 @@ func (c *Client) Logon(req LogonRequest) error {
 	}
 
 	url := fmt.Sprintf("%s/PasswordVault/api/auth/%s/logon", c.BaseURL, c.AuthType)
-	token, err := httpJson.SendRequestRaw(url, "POST", "", req, c.InsecureTLS)
+	token, err := httpJson.SendRequestRaw(url, "POST", "", req, c.InsecureTLS, c.Logger)
 	if err != nil {
 		return fmt.Errorf("Failed to authenticate to the PAS REST API. %s", err)
 	}
@@ -37,7 +37,7 @@ func (c *Client) Logon(req LogonRequest) error {
 func (c Client) Logoff() error {
 	// Set URL for request
 	url := fmt.Sprintf("%s/PasswordVault/api/auth/logoff", c.BaseURL)
-	_, err := httpJson.Post(url, c.SessionToken, nil, c.InsecureTLS)
+	_, err := httpJson.Post(url, c.SessionToken, nil, c.InsecureTLS, c.Logger)
 	if err != nil {
 		return fmt.Errorf("Unable to logoff PAS REST API Web Service. %s", err)
 	}

pkg/cybr/api/client.go

@@ -4,6 +4,8 @@ import (
 	"encoding/gob"
 	"fmt"
 	"os"
+
+	"github.com/infamousjoeg/cybr-cli/pkg/logger"
 )
 
 // Client contains the data necessary for requests to pass successfully
@@ -12,6 +14,7 @@ type Client struct {
 	AuthType     string
 	InsecureTLS  bool
 	SessionToken string
+	Logger       logger.Logger
 }
 
 func getUserHomeDir() (string, error) {
@@ -97,6 +100,13 @@ func GetConfig() (Client, error) {
 	return client, nil
 }
 
+// GetConfigWithLogger is the same as GetConfig except it also sets the logger
+func GetConfigWithLogger(logger logger.Logger) (Client, error) {
+	client, err := GetConfig()
+	client.Logger = logger
+	return client, err
+}
+
 // RemoveConfig file on the local filesystem
 func (c *Client) RemoveConfig() error {
 	// Get user home directory