authentication

package

v1.14.3 Latest Latest Go to latest Published: Mar 26, 2026 License: Apache-2.0, Apache-2.0 Imports: 7 Imported by: 2

Details

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

Repository

github.com/ARGOeu/argo-web-api

Links

Open Source Insights

Documentation ¶

Index ¶

func Authenticate(h http.Header, cfg config.Config) bool
func AuthenticateAdmin(h http.Header, cfg config.Config) bool
func AuthenticateAdminName(h http.Header, cfg config.Config) (bool, string, string)
func AuthenticateAdminTenant(h http.Header, cfg config.Config) (config.MongoConfig, string, error)
func AuthenticateNode(h http.Header, cfg config.Config, nodeName string, isAdmin bool) (config.MongoConfig, string, error)
func AuthenticateTenant(h http.Header, cfg config.Config) (config.MongoConfig, string, error)
func GetComponentRole(h http.Header, cfg config.Config) string
func IsAdminRestricted(h http.Header, cfg config.Config) bool
func IsSuperAdminUI(h http.Header, cfg config.Config) bool
type Auth
type DbConfItem
type DbInfoUsers
type Info
type InfoStruct
type Tenant
type UserItem

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Authenticate ¶

func Authenticate(h http.Header, cfg config.Config) bool

func AuthenticateAdmin ¶

func AuthenticateAdmin(h http.Header, cfg config.Config) bool

AuthenticateAdmin is used to authenticate and administrator of ARGO and allow further CRUD ops wrt the argo_core database (i.e. add a new tenant, modify another tenant's configuration etc)

func AuthenticateAdminName ¶ added in v1.14.3

func AuthenticateAdminName(h http.Header, cfg config.Config) (bool, string, string)

func AuthenticateAdminTenant ¶ added in v1.14.3

func AuthenticateAdminTenant(h http.Header, cfg config.Config) (config.MongoConfig, string, error)

AuthenticateAdminTenant is used to authenticate access to a super admin trying to access a tenant's user route

func AuthenticateNode ¶ added in v1.14.3

func AuthenticateNode(h http.Header, cfg config.Config, nodeName string, isAdmin bool) (config.MongoConfig, string, error)

func AuthenticateTenant ¶

func AuthenticateTenant(h http.Header, cfg config.Config) (config.MongoConfig, string, error)

AuthenticateTenant is used to find which tenant the user making the requests belongs to and return the database configuration for that specific tenant. If the api-key in the request is not found in any tenant an empty configuration is returned along with an error

func GetComponentRole ¶ added in v1.14.3

func GetComponentRole(h http.Header, cfg config.Config) string

GetComponentRole returns a component role if exists

func IsAdminRestricted ¶

func IsAdminRestricted(h http.Header, cfg config.Config) bool

IsAdminRestricted resturns a boolean value if an admin user is in restricted mode or not. Admin user in restricted mode has read only access to certain calls

func IsSuperAdminUI ¶

func IsSuperAdminUI(h http.Header, cfg config.Config) bool

IsSuperAdminUI resturns a boolean value if the user is a dedicated super admin ui service user

Types ¶

type Auth ¶

type Auth struct {
	Name         string `bson:"name"`
	Email        string `bson:"email"`
	ApiKey       string `bson:"api_key"`
	Restricted   bool   `bson:"restricted"`
	SuperAdminUI bool   `bson:"super_admin_ui"`
	Component    string `bson:"component"`
}

type DbConfItem ¶

type DbConfItem struct {
	Store    string `bson:"store"`
	Server   string `bson:"server"`
	Port     int    `bson:"port"`
	Database string `bson:"database"`
	Username string `bson:"username"`
	Password string `bson:"password"`
}

type DbInfoUsers ¶

type DbInfoUsers struct {
	Info   Info         `bson:"info"`
	DbConf []DbConfItem `bson:"db_conf"`
	Users  []UserItem   `bson:"users"`
}

type Info ¶

type Info struct {
	Name string `bson:"name"`
}

type InfoStruct ¶

type InfoStruct struct {
	Name string `bson:"name"`
}

type Tenant ¶

type Tenant struct {
	Info InfoStruct `bson:"info"`
}

type UserItem ¶

type UserItem struct {
	Id     string   `bson:"id"`
	Name   string   `bson:"name"`
	Email  string   `bson:"email"`
	ApiKey string   `bson:"api_key"`
	Roles  []string `bson:"roles"`
}

Source Files ¶

View all Source files

authenticate.go

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