base

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

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

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

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

type AtGroup struct {
	SimpleAts  map[string]*SimpleAttribute
	ComplexAts map[string]*ComplexAttribute
}

type Attribute interface {
	IsSimple() bool
	GetSimpleAt() *SimpleAttribute
	GetComplexAt() *ComplexAttribute
	GetType() *schema.AttrType
}

type AttributeParam struct {
	Name     string
	SchemaId string
	SubAts   map[string]string // simplifies searching and eliminates iteration while filtering denied attributes
}

type AuditEvent struct {
	Id         string // CSN of the event
	Uri        string // URI of the endpoint
	ActorId    string // user's ID, can be null
	ActorName  string // user's name, can be null
	Operation  string // operation
	StatusCode int    // http status code
	Desc       string // description of the error
	IpAddress  string // ip address from where the related request was sent
	Payload    string // payload used for performing operation
}

type AuthData struct {
	TotpSecret  string
	TotpCodes   map[string]bool
	LastSLogin  time.Time
	LastFLogin  time.Time
	FLoginCount int
	Skeys       map[string]*SecurityKey
	WebauthnId  string // a special unique identifier that links user on the authenticator
}

type AuthRequest struct {
	Username string `json:"username"`
	Domain   string `json:"domain"`
	Password string `json:"password"`
	ClientIP string `json:"-"`
	FromLdap bool   `json:"-"`
}

type AuthenticatorData struct {
	RpIdHash     []byte
	Flags        byte
	SignCount    uint32
	AAGUID       string
	CredentialId string
	PubKeyCOSE   map[int]interface{}
	Extensions   map[int]interface{}
	RawData      []byte
}

type ChangePasswordContext struct {
	Rid         string
	NewPassword string
	HashAlgo    string
	Res         *Resource
	*OpContext  // the operation context
}

type ChangePasswordRequest struct {
	Rid      string
	Password string
	ClientIP string
	FromLdap bool
}

type CollectedClientData struct {
	Type             string                 `json:"type"`
	Challenge        string                 `json:"challenge"`
	Origin           string                 `json:"origin"`
	HashAlgorithm    string                 `json:"hashAlgorithm"`
	TokenBinding     TokenBinding           `json:"tokenBinding"`
	ClientExtensions map[string]interface{} `codec:"clientExtensions"`
	RawBytes         []byte
}

type ComplexAttribute struct {
	Name string
	// The SubAts can grow to a large size especially in
	// the resources of type Group. For example "members" attribute
	// may hold references to millions of users.
	// A map is the ideal choice instead of a slice. Resizing the map
	// is cheaper than resizing a slice
	// The key is a random string generated using RandStr() method
	SubAts map[string]map[string]*SimpleAttribute // it can hold a list(but held in a map) of simple sub attributes
	// contains filtered or unexported fields
}

type CreateContext struct {
	Repl       bool // adding here instead of in OpContext so that creation of OpContext can be avoided
	InRes      *Resource
	*OpContext // the operation context
}

type Csn interface {
	TimeMillis() int64

	ChangeCount() uint32

	ReplicaId() uint16

	ModificationCount() uint32

	String() string

	// String value of date and time in RFC3339 format
	DateTime() string
}

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

type DeleteContext struct {
	Rid        string
	Repl       bool
	Rt         *schema.ResourceType
	DeleteCsn  string // a new CSN generated during delete operation, this helps in ordering replication event
	*OpContext        // the operation context
}

type EmptyEvaluator struct {
}

type Evaluator interface {
	Evaluate(rs *Resource) bool
}

type FilterNode struct {
	Op   string
	Name string

	Value     string
	NormValue interface{}
	NvBytes   []byte // the norm value in bytes
	Children  []*FilterNode
	Count     int64 // the number of possible entries this node might evaluate
	// contains filtered or unexported fields
}

type GetContext struct {
	Rid            string
	Username       string
	Rt             *schema.ResourceType
	ParamAttrs     string
	ParamExclAttrs string
	*OpContext     // the operation context
}

type Interceptor interface {
	PreCreate(crCtx *CreateContext) error
	PostCreate(crCtx *CreateContext)

	PrePatch(patchCtx *PatchContext) error
	PostPatch(patchCtx *PatchContext)

	PreDelete(delCtx *DeleteContext) error
	PostDelete(delCtx *DeleteContext)

	PreReplace(replaceCtx *ReplaceContext) error
	PostReplace(replaceCtx *ReplaceContext)
}

type ListResponse struct {
	TotalResults int64
	Resources    []*Resource
	StartIndex   int64
	ItemsPerPage int
}

type LoginResult struct {
	User   *Resource // user is non-nil only if the authentication is successful
	Id     string    // user resource's ID will always be present unless the user is not found
	Status LoginStatus
}

type LoginStatus int

type ModifyGroupsOfUserRequest struct {
	UserRid     string   `json:"userrid"`    // user resource's ID
	AddGids     []string `json:"addgids"`    // list of group resources' IDs
	RemoveGids  []string `json:"removegids"` // list of group resources' IDs
	UserVersion string
	*OpContext
}

type MultiSubAttribute struct {
	SimpleAts []*SimpleAttribute
}

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

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

type OpContext struct {
	Session        *RbacSession
	Sso            bool
	UpdatedSession bool
	ClientIP       string
	Endpoint       string
}

type OpDecision struct {
	Allow            bool
	Deny             bool
	EvalWithoutFetch bool
	EvalFilter       bool
}

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

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

type ParsedPath struct {
	ParentType     *schema.AttrType // name of the sub-attribute's parent
	AtType         *schema.AttrType // name of the (sub-)attribute
	Schema         string           // the schema of the attribute
	Slctr          Selector         // the selection filter present in the path
	Text           string
	IsExtContainer bool
}

type PatchContext struct {
	Repl        bool
	ReplVersion string // to be used only by a replication event
	Rid         string
	Pr          *PatchReq
	Rt          *schema.ResourceType
	Res         *Resource
	*OpContext  // the operation context
}

type PatchOp struct {
	Index      int
	Op         string
	Path       string
	ParsedPath *ParsedPath
	Value      interface{}
}

type PatchReq struct {
	Schemas    []string
	IfMatch    string
	Operations []*PatchOp
	RawReq     []byte // the raw request that gets sent for replication
}

type Permission struct {
	Name          string                     `json:"-"`
	Filter        *FilterNode                `json:"-"`
	OnAnyResource bool                       `json:"onAnyRes"`
	AllowAttrs    map[string]*AttributeParam `json:"-"`
	AllowAll      bool                       `json:"allowAll"`
	// contains filtered or unexported fields
}

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

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

type PubKeyCredParam struct {
	Type string `json:"type"`
	Alg  int    `json:"alg"`
}

type PublicKeyCredentialCreationOptions struct {
	Attestation        string                          `json:"attestation"`
	Challenge          string                          `json:"challenge"`
	RpId               string                          `json:"rpId"`
	RpName             string                          `json:"rpName"`
	UserId             string                          `json:"userId"`
	UserName           string                          `json:"userName"`
	UserDisplayName    string                          `json:"userDisplayName"`
	Timeout            uint64                          `json:"timeout"`
	ExcludeCredentials []PublicKeyCredentialDescriptor `json:"excludeCredentials"`
	PubKeyCredParams   []PubKeyCredParam               `json:"pubKeyCredParams"`
}

type PublicKeyCredentialDescriptor struct {
	Type       string `json:"type,omitempty"`
	Id         string `json:"id,omitempty"`
	Transports string `json:"transports,omitempty"`
}

type PublicKeyCredentialRequestOptions struct {
	Challenge        string   `json:"challenge"`
	RpId             string   `json:"rpId"`
	Timeout          uint64   `json:"timeout"`
	CredIds          []string `json:"credIds"`
	UserVerification string   `json:"userVerification"`
}

type RbacSession struct {
	Roles     map[string]string              `json:"roles"`
	EffPerms  map[string]*ResourcePermission `json:"-"`
	Domain    string                         `json:"iss"`
	Sub       string                         `json:"sub"`
	Exp       int64                          `json:"exp"`
	Iat       int64                          `json:"iat"`
	Jti       string                         `json:"jti"`
	Ito       string                         `json:"ito"` // The ID of the oAuth client to who this JWT was sent to
	Apps      map[string]SamlAppSession      `json:"-"`   // a map of application SAML issuer IDs and their SessionIndexes
	Username  string                         `json:"-"`
	LastAccAt int64                          `json:"-"` // time when this session was last accessed

}

type RbacUser struct {
	Rid   string
	Roles map[string]string // <roleID, displayName> key-value pairs
}

type ReplaceContext struct {
	InRes       *Resource
	IfMatch     string
	Rt          *schema.ResourceType
	Res         *Resource // the resource after replacing
	Repl        bool
	Cloning     bool
	ReplVersion string
	*OpContext  // the operation context
}

type Resource struct {
	TypeName string // resourcetype's name
	Core     *AtGroup
	Ext      map[string]*AtGroup
	AuthData *AuthData // only non-nil for User resource rest of all resources contain nil values
	// contains filtered or unexported fields
}

type ResourcePermission struct {
	RType     *schema.ResourceType
	ReadPerm  *Permission
	WritePerm *Permission
}

type Role struct {
	Id    string
	Name  string
	Perms map[string]*ResourcePermission
}

type SamlAppSession struct {
	SessionIndex string
	NameID       string
	NameIDFormat string
}

type ScimError struct {
	Schemas  []string `json:"schemas"`
	ScimType string   `json:"scimType"`
	Detail   string   `json:"detail"`
	Status   string   `json:"status"`
	// contains filtered or unexported fields
}

type SearchContext struct {
	MaxResults int                    // the maximum number of results returned for a search request
	Filter     *FilterNode            // the search filter
	ResTypes   []*schema.ResourceType // the resource types
	Attrs      []string               // attributes to sent
	RawReq     *SearchRequest
	*OpContext // the operation context
}

type SearchRequest struct {
	Schemas            []string `json:"schemas"`
	Attributes         string   `json:"attributes,omitempty"`
	ExcludedAttributes string   `json:"excludedAttributes,omitempty"`
	Filter             string   `json:"filter"`
	SortBy             string   `json:"sortBy,omitempty"`
	SortOrder          string   `json:"sortOrder,omitempty"`
	StartIndex         int      `json:"startIndex,omitempty"`
	Count              int      `json:"count,omitempty"`
}

type SecurityKey struct {
	DeviceId       string              `json:"deviceId"`     // AAGUID
	CredentialId   string              `json:"credentialId"` // the unique ID of this credential
	Fmt            string              `json:"fmt"`
	SignCount      uint32              `json:"-"`
	PubKeyCOSE     map[int]interface{} `json:"-"`
	RegisteredDate int64               `json:"registeredDate"`
	LastUsedDate   int64               `json:"lastUsedDate"`
}

type Selector interface {
	Find(ca *ComplexAttribute) []string
}

type SimpleAttribute struct {
	Name   string
	Values []interface{}
	// contains filtered or unexported fields
}

type SsoAttr struct {
	Name     string
	NormName string
	Format   string // only applicable to SAML attributes
	ScimExpr string

	StaticVal           string
	StaticMultiValDelim string
	Value               interface{} // only used when executing SAML attribute's template
	// contains filtered or unexported fields
}

type TokenBinding struct {
	Status string `json:"status"`
	Id     string `json:"id"`
}

type VerifyOtpRequest struct {
	Rid      string
	Otp      string
	ClientIP string
	FromLdap bool
}

type WebauthnResponse struct {
	ClientData CollectedClientData
	AuthData   AuthenticatorData
	AttStmt    map[string]interface{}
	Fmt        string
	Signature  []byte
	UserHandle string // the handle that authenticator returns, can be null. This field is unused at the moment

	// sparrow specific internal fields
	ResId string // user resource's ID
	PrId  string // domaincode of provider
	CTime int64  // the time at which challenge was created
}