net

Documentation

Overview

Copyright 2018 Keydap. All rights reserved. Licensed under the Apache License, Version 2.0, see LICENSE.

Index

• Constants
• Variables
• type CodeType
• type LdapSession
• type LogoutNameID
• type LogoutRequest
• type Sparrow
  • func NewSparrowServer(homeDir string, overrideConf string) *Sparrow
  • func (sp *Sparrow) Start()
  • func (sp *Sparrow) Stop()

Constants

const AUTHFLOW_COOKIE string = "_afc"

the authflow cookie

const BASIC_AUTHZ_PREFIX string = "Basic "

const COOKIE_LOGIN_NAME string = "SPLCN"

const OAUTH_CODE_TTL int = 600

the number of seconds an oauth code is valid for

const OTP_LEN = 6

const PARAM_REDIRECT_TO = "redirectTo"

const SSO_COOKIE = "KSPAX" // Keydap Sparrow Auth X (X -> all the authenticated users)

Variables

var API_BASE = "/v2" // NO slash at the end

var DEFAULT_SRV_CONF string = `` /* 355-byte string literal not displayed */

var FORM_URL_ENCODED_TYPE = "application/x-www-form-urlencoded"

var JSON_TYPE = "application/json; charset=UTF-8"

var OAUTH_BASE = "/oauth2" // NO slash at the end

var SAML_BASE = "/saml" // NO slash at the end

var SCIM_JSON_TYPE = "application/scim+json; charset=UTF-8"

var TENANT_COOKIE = "SD"

var TENANT_HEADER = "X-Sparrow-Domain"

Types

type CodeType

type CodeType uint8

const (
	OAuth2 CodeType = iota
	OIDC
	SAML2
)

type LdapSession

type LdapSession struct {
	Id string

	*base.OpContext
	// contains filtered or unexported fields
}

type LogoutNameID

type LogoutNameID struct {
	XMLName xml.Name `xml:"urn:oasis:names:tc:SAML:2.0:assertion NameID"`
	Format  string   `xml:",attr"`
	Value   string   `xml:",chardata"`
}

type LogoutRequest

type LogoutRequest struct {
	ID           string    `xml:",attr"`
	Version      string    `xml:",attr"`
	IssueInstant time.Time `xml:",attr"`
	Issuer       string
	NameID       LogoutNameID
	SessionIndex string
}

this struct is used for parsing recieved logout requests

type Sparrow

type Sparrow struct {
	// contains filtered or unexported fields
}

func NewSparrowServer

func NewSparrowServer(homeDir string, overrideConf string) *Sparrow

func (*Sparrow) Start

func (sp *Sparrow) Start()

func (*Sparrow) Stop

func (sp *Sparrow) Stop()