utils

Documentation

Overview

Copyright 2024 BeyondTrust. All rights reserved. utils responsible for utility functions.

Copyright 2024 BeyondTrust. All rights reserved. Package utils implements inputs validations

Index

• func FormatErrorMessage(err validator.FieldError) string
• func GetPFXContent(clientCertificatePath string, clientCertificateName string, ...) (string, string, error)
• func ValidateCertificateInfo(params ValidationParams) error
• func ValidateCreateManagedAccountInput(accountDetails entities.AccountDetails) (entities.AccountDetails, error)
• func ValidateData(objDetails interface{}) error
• func ValidateInputs(params ValidationParams) error
• func ValidatePaths(secretPaths []string, isManagedAccount bool, separator string, ...) []string
• func ValidateSinglePath(maxPath int, maxName int, invalidPathName string, invalidName string, ...) (string, error)
• func ValidateURL(apiUrl string) error
• type HttpClientObj
  • func GetHttpClient(clientTimeOut int, verifyCa bool, certificate string, certificate_key string, ...) (*HttpClientObj, error)
  • func (client *HttpClientObj) CallSecretSafeAPI(callSecretSafeAPIObj entities.CallSecretSafeAPIObj) (io.ReadCloser, int, error, error)
  • func (client *HttpClientObj) CreateMultiPartRequest(url, fileName string, metadata []byte, fileContent string, apiVersion string) (io.ReadCloser, error)
  • func (client *HttpClientObj) GetAuthorizationHeader(accessToken string, apiKey string) string
  • func (client *HttpClientObj) GetGeneralList(url string, apiVersion string, method string, ...) ([]byte, error)
  • func (client *HttpClientObj) HttpRequest(url string, method string, body bytes.Buffer, accessToken string, ...) (closer io.ReadCloser, scode int, technicalError error, businessError error)
  • func (client *HttpClientObj) MakeRequest(callSecretSafeAPIObj *entities.CallSecretSafeAPIObj, ...) ([]byte, error)
  • func (client *HttpClientObj) SetApiVersion(url string, apiVersion string) string
• type UserInputValidaton
• type ValidationParams

Functions

func FormatErrorMessage

func FormatErrorMessage(err validator.FieldError) string

FormatErrorMessage responsible for formating errors text.

func GetPFXContent

func GetPFXContent(clientCertificatePath string, clientCertificateName string, clientCertificatePassword string, logger logging.Logger) (string, string, error)

GetPFXContent decrypt pfx certificate.

func ValidateCertificateInfo

func ValidateCertificateInfo(params ValidationParams) error

ValidateCertificateInfo validate certificate data.

func ValidateCreateManagedAccountInput

func ValidateCreateManagedAccountInput(accountDetails entities.AccountDetails) (entities.AccountDetails, error)

ValidateCreateManagedAccountInput responsible for validating Managed Account input

func ValidateData

func ValidateData(objDetails interface{}) error

ValidateInputs responsible for validating objects Details (WorkGroupDetails, FolderDetails, SecretTextDetails...)

func ValidateInputs

func ValidateInputs(params ValidationParams) error

ValidateInputs is responsible for validating end-user inputs.

func ValidatePaths

func ValidatePaths(secretPaths []string, isManagedAccount bool, separator string, logger logging.Logger) []string

This method is responsbile for validating that the paths and names are valid.

func ValidateSinglePath

func ValidateSinglePath(maxPath int, maxName int, invalidPathName string, invalidName string, maxPathDepth int, retrievalData []string, separator string) (string, error)

ValidateSinglePath responsbile for validating that one path and one name are valid.

func ValidateURL

func ValidateURL(apiUrl string) error

ValidateURL responsible for validating the Password Safe API URL.

Types

type HttpClientObj

type HttpClientObj struct {
	HttpClient *http.Client
	// contains filtered or unexported fields
}

HttpClientObj responsible for http request instance.

func GetHttpClient

func GetHttpClient(clientTimeOut int, verifyCa bool, certificate string, certificate_key string, logger logging.Logger) (*HttpClientObj, error)

GetHttpClient is responsible for configuring an HTTP client and transport for API calls.

func (*HttpClientObj) CallSecretSafeAPI

func (client *HttpClientObj) CallSecretSafeAPI(callSecretSafeAPIObj entities.CallSecretSafeAPIObj) (io.ReadCloser, int, error, error)

func (*HttpClientObj) CreateMultiPartRequest

func (client *HttpClientObj) CreateMultiPartRequest(url, fileName string, metadata []byte, fileContent string, apiVersion string) (io.ReadCloser, error)

CreateMultipartRequest creates and sends multipart request.

func (*HttpClientObj) GetAuthorizationHeader

func (client *HttpClientObj) GetAuthorizationHeader(accessToken string, apiKey string) string

GetAuthorizationHeader Get authorization header string

func (*HttpClientObj) GetGeneralList

func (client *HttpClientObj) GetGeneralList(url string, apiVersion string, method string, exponentialBackOff *backoff.ExponentialBackOff) ([]byte, error)

GetGeneralList get list for any module.

func (*HttpClientObj) HttpRequest

func (client *HttpClientObj) HttpRequest(url string, method string, body bytes.Buffer, accessToken string, apiKey string, contentType string, apiVersion string) (closer io.ReadCloser, scode int, technicalError error, businessError error)

HttpRequest makes http request to the server.

func (*HttpClientObj) MakeRequest

func (client *HttpClientObj) MakeRequest(callSecretSafeAPIObj *entities.CallSecretSafeAPIObj, exponentialBackOff *backoff.ExponentialBackOff) ([]byte, error)

MakeRequest Make http request to API.

func (*HttpClientObj) SetApiVersion

func (client *HttpClientObj) SetApiVersion(url string, apiVersion string) string

SetApiVersion Set API Version to URL.

type UserInputValidaton

type UserInputValidaton struct {
	ApiKey                 string `validate:"omitempty,min=128,max=263"`
	ClientId               string `validate:"omitempty,min=36,max=36,required_without=ApiKey"`
	ClientSecret           string `validate:"omitempty,min=36,max=64,required_without=ApiKey"`
	ApiVersion             string `validate:"omitempty,min=3,max=3"`
	ApiUrl                 string `validate:"required,http_url"`
	ClientTimeOutinSeconds int    `validate:"gte=1,lte=300"`
	Separator              string `validate:"omitempty,required,min=1,max=1"`
	MaxFileSecretSizeBytes int    `validate:"omitempty,gte=1,lte=5000000"`
}

UserInputValidaton responsible for input paramerter validation.

type ValidationParams

type ValidationParams struct {
	ApiKey                     string
	ClientID                   string
	ClientSecret               string
	ApiUrl                     *string
	ApiVersion                 string
	ClientTimeOutInSeconds     int
	Separator                  *string
	VerifyCa                   bool
	Logger                     logging.Logger
	Certificate                string
	CertificateKey             string
	RetryMaxElapsedTimeMinutes *int
	MaxFileSecretSizeBytes     *int
}