definition

Documentation

Index

• type APIAllKeys
• type AccessDefinition
• type AccessSpec
• type HashType
• type SessionState

Types

type APIAllKeys

type APIAllKeys struct {
	APIKeys []string `json:"keys"`
}

type AccessDefinition

type AccessDefinition struct {
	APIName     string       `json:"api_name" msg:"api_name"`
	APIID       string       `json:"api_id" msg:"api_id"`
	Versions    []string     `json:"versions" msg:"versions"`
	AllowedURLs []AccessSpec `bson:"allowed_urls"  json:"allowed_urls" msg:"allowed_urls"` // mapped string MUST be a valid regex
}

AccessDefinition defines which versions of an API a key has access to

type AccessSpec

type AccessSpec struct {
	URL     string   `json:"url" msg:"url"`
	Methods []string `json:"methods" msg:"methods"`
}

AccessSpecs define what URLS a user has access to an what methods are enabled

type HashType

type HashType string

const (
	HASH_PlainText HashType = ""
	HASH_BCrypt    HashType = "bcrypt"
)

type SessionState

type SessionState struct {
	LastCheck        int64                       `json:"last_check" msg:"last_check"`
	Allowance        float64                     `json:"allowance" msg:"allowance"`
	Rate             float64                     `json:"rate" msg:"rate"`
	Per              float64                     `json:"per" msg:"per"`
	Expires          int64                       `json:"expires" msg:"expires"`
	QuotaMax         int64                       `json:"quota_max" msg:"quota_max"`
	QuotaRenews      int64                       `json:"quota_renews" msg:"quota_renews"`
	QuotaRemaining   int64                       `json:"quota_remaining" msg:"quota_remaining"`
	QuotaRenewalRate int64                       `json:"quota_renewal_rate" msg:"quota_renewal_rate"`
	AccessRights     map[string]AccessDefinition `json:"access_rights" msg:"access_rights"`
	OrgID            string                      `json:"org_id" msg:"org_id"`
	OauthClientID    string                      `json:"oauth_client_id" msg:"oauth_client_id"`
	OauthKeys        map[string]string           `json:"oauth_keys" msg:"oauth_keys"`
	BasicAuthData    struct {
		Password string   `json:"password" msg:"password"`
		Hash     HashType `json:"hash_type" msg:"hash_type"`
	} `json:"basic_auth_data" msg:"basic_auth_data"`
	JWTData struct {
		Secret string `json:"secret" msg:"secret"`
	} `json:"jwt_data" msg:"jwt_data"`
	HMACEnabled   bool   `json:"hmac_enabled" msg:"hmac_enabled"`
	HmacSecret    string `json:"hmac_string" msg:"hmac_string"`
	IsInactive    bool   `json:"is_inactive" msg:"is_inactive"`
	ApplyPolicyID string `json:"apply_policy_id" msg:"apply_policy_id"`
	DataExpires   int64  `json:"data_expires" msg:"data_expires"`
	Monitor       struct {
		TriggerLimits []float64 `json:"trigger_limits" msg:"trigger_limits"`
	} `json:"monitor" msg:"monitor"`
	EnableDetailedRecording bool        `json:"enable_detail_recording" msg:"enable_detail_recording"`
	MetaData                interface{} `json:"meta_data" msg:"meta_data"`
	Tags                    []string    `json:"tags" msg:"tags"`
	Alias                   string      `json:"alias" msg:"alias"`
	LastUpdated             string      `json:"last_updated" msg:"last_updated"`
	IdExtractorDeadline     int64       `json:"id_extractor_deadline" msg:"id_extractor_deadline"`
	SessionLifetime         int64       `bson:"session_lifetime" json:"session_lifetime"`
	// contains filtered or unexported fields
}

SessionState objects represent a current API session, mainly used for rate limiting.