furnace.auth vocabulary - Factor Documentation (original) (raw)

furnace.auth vocabulary
Factor handbook » Vocabulary index

Documentation
Furnace authentication

Metadata

Words

Tuple classes

Class	Superclass	Slots
protected	filter-responder	description capabilities
realm	dispatcher	name users checksum secure
secure-realm-only	filter-responder
user-saver	tuple	user disposed

Generic words

Word	Stack effect
init-realm	( realm -- )
init-user-profile	( responder -- )
logged-in-username	( realm -- username )
login-required*	( description capabilities realm -- response )
user-registered	( user realm -- response )

Symbol words

capabilities
logged-in-user

Ordinary words

Word	Stack effect
	( responder -- responder' )
	( responder -- protected )
	( responder -- secure-realm-only )
	( user -- user-saver )
>>encoded-password	( user string -- user )
check-login	( password username -- user/f )
current-profile	( -- assoc )
define-capability	( word -- )
encode-password	( string salt -- bytes )
have-capabilities?	( capabilities -- ? )
if-secure-realm	( quot -- )
init-user	( user -- )
logged-in?	( -- ? )
login-required	( description capabilities -- * )
new-realm	( responder name class -- realm )
password-mismatch	( -- * )
same-password-twice	( -- )
save-user-after	( user -- )
uchange	( quot key -- )
uget	( key -- value )
user-changed	( -- )
user-exists	( -- * )
username	( -- string/f )
users	( -- provider )
uset	( value key -- )
valid-login?	( password user -- ? )

Class predicate words

Word	Stack effect
protected?	( object -- ? )
realm?	( object -- ? )
secure-realm-only?	( object -- ? )
user-saver?	( object -- ? )

Files

resource:basis/furnace/auth/auth.factor
resource:basis/furnace/auth/auth-docs.factor

Metadata files

resource:basis/furnace/auth/authors.txt
resource:basis/furnace/auth/summary.txt
resource:basis/furnace/auth/tags.txt

Children from resource:basis

Vocabulary	Summary
furnace.auth.basic	Basic client authentication
furnace.auth.features
furnace.auth.login	Login page authentication
furnace.auth.providers	Pluggable authentication backends