at_verb_spec library

Classes

Config

Config verb is used for configuring or viewing an @sign's block/allow list. 'from' verb functionality is dertermined by using the configurations of 'config' verb. [...]

Cram

The cram verb is used to authenticate the @sign to the secondary server. On successful request, binds the @sign to the secondary server. The secret is appended to the challenge (response of from verb) and gives a SHA512 digest which serves as an input to the CRAM verb. On successful cram verb request, the @sign is successfully authenticated to the secondary server and allows user to Add/Update, Delete and lookup the keys in their respective secondary servers. [...]

Delete

To delete an entry, an @sign client transmits a well formed delete request to the @sign secondary server. The @sign should be authenticated using the cram verb prior to use the delete verb. A malformed request closes the @sign client connection. A delete request must contain the distinguished name of the key to be deleted. [...]

From

The "from" verb is used to establish a new @sign connection to an @sign secondary server. It tells the @server what @sign you claim to be and the @server on successful connection gives a challenge for authentication of @sign [...]

LocalLookup

The "llookup" verb can be used to locally lookup keys stored on the secondary server. To perform local look up, the user should be successfully authenticated via the "cram" verb. malformed request closes the @sign client connection. [...]

Lookup

The “lookup” verb allows the lookup of a particular address in the @ handles namespace. The “lookup” verb provides public lookups and specific key look ups when authenticated as a particular @ handle using the “from” and “pol” verbs. If a lookup is valid the resulting information is returned with the data: header and a carriage return and a further @ prompt ready for further commands. If the lookup is not valid then a null is returned again with the data: header. The @sign should be authenticated using the cram verb prior to use the lookup verb. A malformed request closes the @sign client connection. [...]

Monitor

Notify

The “notify” verb allows the notify user. The @sign should be authenticated using the cram/pkam verb prior to use the notify verb. A malformed request does not close the @sign client connection. [...]

NotifyList

The “notify:list” allows the notify user. The @sign should be authenticated using the cram/pkam verb prior to use the notify verb. A malformed request does not close the @sign client connection. [...]

Pkam

The pkam( Public Key Authentication Mechanism) verb is used to authenticate the @sign to the secondary server. This is similar to how ssh authentication works. On successful request, binds the @sign to the secondary server. On successful pkam verb request, the @sign is successfully authenticated to the secondary server and allows user to Add/Update, Delete and lookup the keys in their respective secondary servers. [...]

Pol

The "pol" verb allows to switch as another @sign user. To switch as another user, use from:<@sign>(The another @sign user) verb which gives a response as proof:; then use pol verb. On successful authentication, the prompt changes to the another @sign user. An invalid syntax closes the atsign client connection. [...]

ProxyLookup

The "plookup" verb, provides a proxied public lookups for a resolver that perhaps is behind a firewall. This will allow a resolver to contact a @ server and have the @ server lookup both public @ handles information. This will be useful in large enterprise environments where they would want all lookups going through a single secondary server for the entity or where a single port needs to be opened through a firewall to lookup @ handles. The @sign should be authenticated using cram verb prior to use the plookup verb. A malformed request closes the @sign client connection. [...]

Response

Scan

The "scan" verb scans the available keys for you at the public level. If the key has a '_' character has it first character, then it is omitted from the scan list, although it can still be looked up if known. The scan verb when used by unauthenticated @sign user, scans for keys that are available to you at your current state. The scan when used by an authenticated user via the cram verb, scans all the available keys on the secondary server. [...]

Stats

Syntax: stats stats verb used to get all the available metrics example: Number of active inbound/outbound connections, last commit ID etc.

StreamVerb

Sync

The "sync" verb is used to fetch all the changes after a given commit sequence number from the commit log on the server [...]

Update

The update verb adds/updates the keys in the secondary server. The update verb is used to set public responses and specific responses for a particular authenticated users after using the pol verb. The @sign should be authenticated using cram verb prior to use the update verb. A malformed request closes the @sign client connection. [...]

UpdateMeta

Verb

Represents a Verb in the @sign protocol.

VerbExecutor

VerbHandler

VerbHandlerManager