File: auth-source.el.html

This is the auth-source.el package. It lets users tell Gnus how to authenticate in a single place. Simplicity is the goal. Instead of providing 5000 options, we'll stick to simple, easy to understand options.

See the auth.info Info documentation for details.

TODO:

- never decode the backend file unless it's necessary
- a more generic way to match backends and search backend contents
- absorb netrc.el and simplify it
- protect passwords better
- allow creating and changing netrc lines (not files) e.g. change a password

Defined variables (24)

auth-source-backend-parser-functionsList of auth-source parser functions.
auth-source-cache-expiryHow many seconds passwords are cached, or nil to disable expiring.
auth-source-creation-defaultsDefaults for creating token values. Usually let-bound.
auth-source-creation-promptsDefault prompts for token values. Usually let-bound.
auth-source-debugWhether auth-source should log debug messages.
auth-source-do-cacheWhether auth-source should cache information with ‘password-cache’.
auth-source-gpg-encrypt-toList of recipient keys that ‘authinfo.gpg’ encrypted to.
auth-source-ignore-non-existing-fileIf set non-nil, file-based backends are ignored if the file does not exist.
auth-source-ignored-keysList of meta keys to be ignored in data stores.
auth-source-netrc-use-gpg-tokensSet this to tell ‘auth-source’ when to create GPG password
auth-source-protocolsList of authentication protocols and their names.
auth-source-save-behaviorIf set, auth-source will respect it for save behavior.
auth-sourcesList of authentication sources.
authinfo-hiddenRegexp matching elements in .authinfo/.netrc files that should be hidden.
authinfo-hide-elementsWhether to use ‘authinfo-hidden’ to hide elements in authinfo files.
authinfo-mode-abbrev-tableAbbrev table for ‘authinfo-mode’.
authinfo-mode-hookHook run after entering ‘authinfo-mode’.
authinfo-mode-mapKeymap for ‘authinfo-mode’.
authinfo-mode-syntax-tableSyntax table for ‘authinfo-mode’.
read-passwd--hide-passwordToggle whether password should be hidden in minibuffer.
read-passwd--mode-line-iconPropertized mode line icon for showing/hiding passwords.
read-passwd-mapKeymap used while reading passwords.
read-passwd-modeNon-nil if Read-Passwd mode is enabled.
read-passwd-mode-hookHook run after entering or leaving ‘read-passwd-mode’.

Defined functions (81)

auth-info-password(AUTH-INFO)
auth-source--aget(ALIST KEY)
auth-source--aput(VAR KEY VAL)
auth-source--aput-1(ALIST KEY VAL)
auth-source--decode-octal-string(STRING)
auth-source--deobfuscate(DATA)
auth-source--obfuscate(STRING)
auth-source--pad(STRING LENGTH)
auth-source--symbol-keyword(SYMBOL)
auth-source--unpad(STRING)
auth-source-backend(&rest SLOTS)
auth-source-backend--eieio-childp(OBJ)
auth-source-backend-child-p(OBJ)
auth-source-backend-p(OBJ)
auth-source-backend-parse(ENTRY)
auth-source-backend-parse-parameters(ENTRY BACKEND)
auth-source-backends()
auth-source-backends-parser-file(ENTRY)
auth-source-backends-parser-macos-keychain(ENTRY)
auth-source-backends-parser-secrets(ENTRY)
auth-source-current-line(&optional POS)
auth-source-delete(&rest SPEC)
auth-source-do-debug(&rest MSG)
auth-source-do-trivia(&rest MSG)
auth-source-do-warn(&rest MSG)
auth-source-ensure-strings(VALUES)
auth-source-epa-extract-gpg-token(SECRET FILE)
auth-source-epa-make-gpg-token(SECRET FILE)
auth-source-file-name-p(FILE)
auth-source-forget(SPEC)
auth-source-forget+(&rest SPEC)
auth-source-forget-all-cached()
auth-source-format-cache-entry(SPEC)
auth-source-format-prompt(PROMPT ALIST)
auth-source-json-check(HOST USER PORT REQUIRE ITEM)
auth-source-json-search
auth-source-keys(SPEC)
auth-source-macos-keychain-create(&rest SPEC)
auth-source-macos-keychain-result-append(RESULT GENERIC K V)
auth-source-macos-keychain-search
auth-source-macos-keychain-search-items
auth-source-netrc-create
auth-source-netrc-element-or-first(V)
auth-source-netrc-looking-at-token()
auth-source-netrc-normalize(ALIST FILENAME)
auth-source-netrc-parse
auth-source-netrc-parse-all(FILE)
auth-source-netrc-parse-entries(CHECK MAX)
auth-source-netrc-parse-next-interesting()
auth-source-netrc-parse-one()
auth-source-netrc-saver(FILE ADD)
auth-source-netrc-search
auth-source-pick-first-password(&rest SPEC)
auth-source-plstore-create
auth-source-plstore-search
auth-source-read-char-choice(PROMPT CHOICES)
auth-source-read-passwd-create
auth-source-read-passwd-search
auth-source-recall(SPEC)
auth-source-remember(SPEC FOUND)
auth-source-remembered-p(SPEC)
auth-source-returned-keys(SPEC)
auth-source-search
auth-source-search-backends(BACKENDS SPEC MAX CREATE DELETE REQUIRE)
auth-source-search-collection(COLLECTION VALUE)
auth-source-search-keys(SPEC)
auth-source-search-spec(SPEC)
auth-source-secrets-create
auth-source-secrets-listify-pattern(PATTERN)
auth-source-secrets-saver(COLLECTION ITEM SECRET ARGS)
auth-source-secrets-search
auth-source-specmatchp(SPEC STORED)
auth-source-token-passphrase-callback-function(CONTEXT KEY-ID FILE)
auth-source-user-and-password(HOST &optional USER)
authinfo--hide-passwords(START END)
authinfo--toggle-display(OVERLAY HIDE)
authinfo-mode()
read-passwd(PROMPT &optional CONFIRM DEFAULT)
read-passwd--hide-password()
read-passwd-mode(&optional ARG)
read-passwd-toggle-visibility()

Defined faces (0)