auth

package

v1.12.13 Latest Latest Go to latest Published: Nov 26, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/safedep/vet

Links

Documentation ¶

Index ¶

func ApiKey() string
func ApiUrl() string
func CloudAccessToken() string
func CloudIdentityServiceAudience() string
func CloudIdentityServiceBaseUrl() string
func CloudIdentityServiceClientId() string
func CloudIdentityServiceDeviceCodeUrl() string
func CloudIdentityServiceTokenUrl() string
func CloudRefreshToken() string
func CommunityMode() bool
func CommunityServicesApiUrl() string
func ControlPlaneClientConnection(name string) (*grpc.ClientConn, error)
func ControlTowerUrl() string
func DataPlaneUrl() string
func DefaultApiUrl() string
func DefaultCommunityApiUrl() string
func InsightsApiV2Url() string
func InsightsV2ClientConnection(name string) (*grpc.ClientConn, error)
func InsightsV2CommunityClientConnection(name string) (*grpc.ClientConn, error)
func IsAccessTokenExpired() (bool, error)
func MalwareAnalysisClientConnection(name string) (*grpc.ClientConn, error)
func MalwareAnalysisCommunityClientConnection(name string) (*grpc.ClientConn, error)
func PersistApiKey(key, domain string) error
func PersistCloudTokens(accessToken, refreshToken, domain string) error
func PersistTenantDomain(domain string) error
func RefreshCloudSession() error
func SetRuntimeApiKey(key string)
func SetRuntimeCloudTenant(domain string)
func SetRuntimeCommunityMode()
func ShouldCheckAccessTokenExpiry() bool
func SyncApiUrl() string
func SyncClientConnection(name string) (*grpc.ClientConn, error)
func TenantDomain() string
func Verify() error
type Config
- func DefaultConfig() Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ApiKey ¶

func ApiKey() string

func ApiUrl ¶

func ApiUrl() string

func CloudAccessToken ¶ added in v1.8.0

func CloudAccessToken() string

func CloudIdentityServiceAudience ¶ added in v1.8.0

func CloudIdentityServiceAudience() string

func CloudIdentityServiceBaseUrl ¶ added in v1.8.0

func CloudIdentityServiceBaseUrl() string

func CloudIdentityServiceClientId ¶ added in v1.8.0

func CloudIdentityServiceClientId() string

func CloudIdentityServiceDeviceCodeUrl ¶ added in v1.8.0

func CloudIdentityServiceDeviceCodeUrl() string

func CloudIdentityServiceTokenUrl ¶ added in v1.8.0

func CloudIdentityServiceTokenUrl() string

func CloudRefreshToken ¶ added in v1.8.0

func CloudRefreshToken() string

func CommunityMode ¶ added in v1.0.0

func CommunityMode() bool

func CommunityServicesApiUrl ¶ added in v1.10.1

func CommunityServicesApiUrl() string

func ControlPlaneClientConnection ¶ added in v1.8.0

func ControlPlaneClientConnection(name string) (*grpc.ClientConn, error)

Create a gRPC client connection for the control plane based on available configuration

func ControlTowerUrl ¶ added in v1.8.0

func ControlTowerUrl() string

func DataPlaneUrl ¶ added in v1.8.9

func DataPlaneUrl() string

func DefaultApiUrl ¶

func DefaultApiUrl() string

func DefaultCommunityApiUrl ¶ added in v1.0.0

func DefaultCommunityApiUrl() string

func InsightsApiV2Url ¶ added in v1.8.3

func InsightsApiV2Url() string

func InsightsV2ClientConnection ¶ added in v1.8.3

func InsightsV2ClientConnection(name string) (*grpc.ClientConn, error)

func InsightsV2CommunityClientConnection ¶ added in v1.11.2

func InsightsV2CommunityClientConnection(name string) (*grpc.ClientConn, error)

func IsAccessTokenExpired ¶ added in v1.12.3

func IsAccessTokenExpired() (bool, error)

func MalwareAnalysisClientConnection ¶ added in v1.8.9

func MalwareAnalysisClientConnection(name string) (*grpc.ClientConn, error)

func MalwareAnalysisCommunityClientConnection ¶ added in v1.10.1

func MalwareAnalysisCommunityClientConnection(name string) (*grpc.ClientConn, error)

func PersistApiKey ¶ added in v1.8.0

func PersistApiKey(key, domain string) error

func PersistCloudTokens ¶ added in v1.8.0

func PersistCloudTokens(accessToken, refreshToken, domain string) error

func PersistTenantDomain ¶ added in v1.8.0

func PersistTenantDomain(domain string) error

func RefreshCloudSession ¶ added in v1.12.3

func RefreshCloudSession() error

func SetRuntimeApiKey ¶ added in v1.8.0

func SetRuntimeApiKey(key string)

func SetRuntimeCloudTenant ¶ added in v1.8.0

func SetRuntimeCloudTenant(domain string)

func SetRuntimeCommunityMode ¶ added in v1.5.9

func SetRuntimeCommunityMode()

SetRuntimeCommunityMode sets the runtime mode to community without persisting it to the configuration file.

func ShouldCheckAccessTokenExpiry ¶ added in v1.12.3

func ShouldCheckAccessTokenExpiry() bool

func SyncApiUrl ¶ added in v1.8.0

func SyncApiUrl() string

func SyncClientConnection ¶ added in v1.8.0

func SyncClientConnection(name string) (*grpc.ClientConn, error)

func TenantDomain ¶ added in v1.8.0

func TenantDomain() string

func Verify ¶

func Verify() error

Verify authentication to the data plane using API key and Ping Service.

Types ¶

type Config ¶

type Config struct {
	ApiUrl                    string    `yaml:"api_url"`
	ApiKey                    string    `yaml:"api_key"`
	Community                 bool      `yaml:"community"`
	DataPlaneApiUrl           string    `yaml:"data_plane_api_url"`
	ControlPlaneApiUrl        string    `yaml:"control_api_url"`
	SyncApiUrl                string    `yaml:"sync_api_url"`
	InsightsApiV2Url          string    `yaml:"insights_api_v2_url"`
	CommunityServicesApiUrl   string    `yaml:"community_services_api_url"`
	TenantDomain              string    `yaml:"tenant_domain"`
	CloudAccessToken          string    `yaml:"cloud_access_token"`
	CloudRefreshToken         string    `yaml:"cloud_refresh_token"`
	CloudAccessTokenUpdatedAt time.Time `yaml:"cloud_access_token_updated_at"`
}

func DefaultConfig ¶ added in v1.8.0

func DefaultConfig() Config

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL