security

Documentation

Index

• Variables

Variables

var ByKey = APIKeySecurity(auth.KeySecurityScheme, func() {
	Description("key based auth.")
	Scope("consumer", "consumer based tool access")
	Scope("producer", "producer based tool access")
})

var ByKeyHeader = func() {
	Header(fmt.Sprintf("apikey_token:%s", auth.APIKeyHeader), String, "API Key header")
}

var ByKeyNamedHeader = func(name string) {
	Header(fmt.Sprintf("apikey_token:%s", name), String, "API Key header")
}

var ByKeyPayload = func() {
	APIKey(auth.KeySecurityScheme, "apikey_token", String)
}

var DeleteSessionCookie = func() {
	Cookie(fmt.Sprintf("session_cookie:%s", auth.SessionCookie), String, func() {
	})

	CookieMaxAge(-1)
	CookieSecure()
	CookieHTTPOnly()
}

var ProjectHeader = func() {
	Header(fmt.Sprintf("project_slug_input:%s", auth.ProjectHeader), String, "project header")
}

var ProjectParam = func(name string) {
	Param(name)
}

var ProjectPayload = func() {
	APIKey(auth.ProjectSlugSecuritySchema, "project_slug_input", String)
}

var ProjectPayloadNamed = func(name string) {
	APIKey(auth.ProjectSlugSecuritySchema, name, String)
}

var ProjectSlug = APIKeySecurity(auth.ProjectSlugSecuritySchema, func() {
	Description("project slug header auth.")
})

var Session = APIKeySecurity(auth.SessionSecurityScheme, func() {
	Description("Session based auth. By cookie or header.")
})

Session defines the security scheme for session-based authentication

var SessionHeader = func() {
	Header(fmt.Sprintf("session_token:%s", auth.SessionHeader), String, "Session header")
}

var SessionPayload = func() {
	APIKey(auth.SessionSecurityScheme, "session_token", String)
}

var WriteSessionCookie = func() {
	Cookie(fmt.Sprintf("session_cookie:%s", auth.SessionCookie), String, func() {
	})

	CookieMaxAge(2592000)
	CookieSecure()
	CookieHTTPOnly()
	CookiePath("/")
}