Documentation
¶
Overview ¶
Package browsercookie extracts browser cookies for Canvas authentication.
Index ¶
- Variables
- func AvailableBrowsers() []string
- func ExtractCookies(ctx context.Context, host string) (sessionCookie, csrfToken string, err error)
- func ExtractCookiesForBrowser(ctx context.Context, host, browserName string) (sessionCookie, csrfToken string, err error)
- func IsCSRFCookie(cookie *http.Cookie) bool
- func IsSessionCookie(cookie *http.Cookie) bool
- type CookieReader
- type DefaultReader
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNoSessionCookie = errors.New("no session cookie found for host")
ErrNoSessionCookie is returned when no session cookie is found for the host.
Functions ¶
func AvailableBrowsers ¶
func AvailableBrowsers() []string
AvailableBrowsers returns browser names supported on the current OS.
func ExtractCookies ¶
ExtractCookies reads Canvas cookies for host. It filters by exact host match
func ExtractCookiesForBrowser ¶
func ExtractCookiesForBrowser(ctx context.Context, host, browserName string) (sessionCookie, csrfToken string, err error)
ExtractCookiesForBrowser is like ExtractCookies but restricted to a single
func IsCSRFCookie ¶
IsCSRFCookie reports whether cookie is the Canvas CSRF token cookie.
func IsSessionCookie ¶
IsSessionCookie reports whether cookie is a known Canvas session cookie.
Types ¶
type CookieReader ¶
type CookieReader interface {
ReadCookies(ctx context.Context, filters ...kooky.Filter) (kooky.Cookies, error)
}
CookieReader abstracts cookie reading for testability.
var Reader CookieReader = &DefaultReader{}
Reader is the package-level cookie reader, overridable for dependency injection.
type DefaultReader ¶ added in v0.4.0
type DefaultReader struct{}
func (*DefaultReader) ReadCookies ¶ added in v0.4.0
Source Files
Click to show internal directories.
Click to hide internal directories.