Table of Contents

System Information

Definition Index

• ORG.SHIRAKUMO.SYSTEM-AUTH

  No documentation provided.

  • EXTERNAL CLASS

    LOGIN

    Source

    Representation of a login session.
    
    You must call LOGOUT when you are done with the session to free up
    system resources.
    
    See USERNAME
    See LOGIN
    See LOGOUT
    See CHANGE-PASSWORD
    See FIELD

  • EXTERNAL CONDITION

    AUTH-ERROR

    Source

    Error signalled when a request fails.
    
    This may be for any number of reasons -- invalid arguments, invalid
    password, system busy, some internal failure, you name it.
    
    See MESSAGE

  • EXTERNAL GENERIC-FUNCTION

    CHANGE-PASSWORD

    • LOGIN
    • OLD-PASSWORD
    • NEW-PASSWORD
    • &KEY
    • &ALLOW-OTHER-KEYS

    Source

    Attempts to change the password/token for the given login.
    
    You must supply both the old and the new password again. If the
    old-password is a STREAM and the new-password is NIL, then three lines
    will be read from the stream: the old password, the new password, and
    a repetition of the new password for safety. The stream must be
    interactive and bidirectional.
    
    If successful returns the login. If changing the password fails for
    some reason, an AUTH-ERROR is signalled.
    
    See LOGIN (type)

  • EXTERNAL GENERIC-FUNCTION

    FIELD

    • LOGIN
    • FIELD
    • &KEY
    • DEFAULT
    • PASSWORD
    • &ALLOW-OTHER-KEYS

    Source

    Accesses a user account field.
    
    Whether you can actually write to any field at all is dependant on the
    system and the authorisation of the running process. If writing to a
    field fails, an AUTH-ERROR is signalled.
    
    When the field is T, returns a plist of all available fields.
    The set of available fields is system dependent, but should in the
    very least include the following:
    
      :NAME              --- The username
      :PRIMARY-GROUP-ID  --- The ID number of the primary group of the
                             user.
      :COMMENT           --- An arbitrary comment associated with the
                             account.
      :HOME              --- The home directory path of the user.
    
    See LOGIN (type)

  • EXTERNAL GENERIC-FUNCTION

    (SETF FIELD)

    • VALUE
    • LOGIN
    • FIELD
    • &KEY
    • DEFAULT
    • PASSWORD
    • &ALLOW-OTHER-KEYS

    Source

    No documentation provided.
  • EXTERNAL GENERIC-FUNCTION

    LIST-ACCOUNTS

    • &KEY

    Source

    Lists all known user account names available on the system.
    
    Note that not all accounts on this list may be logged in to, some may
    be reserved for system service use instead. Some accounts may also be
    temporarily missing due to network issues or other system related
    outages. Suffice to say this list is neither static nor necessarily
    even authoritative.
    
    See LOGIN

  • EXTERNAL GENERIC-FUNCTION

    LOGIN

    • LOGIN
    • PASSWORD
    • &KEY
    • CONFDIR
    • SERVICE-NAME
    • &ALLOW-OTHER-KEYS

    Source

    Log in to a user account with a token/password.
    
    The username should be the name of the account to log in with, and the
    password either a string for the user account's token/password, or a
    stream from which the password will be prompted.
    
    If successful returns a LOGIN instance that you can use to change the
    password or query account fields with. You must call LOGOUT when you
    are done with the session to free up system resources.
    
    If logging in fails for some reason, an AUTH-ERROR is signalled. This
    may either be because there is no account of that name, the password
    is wrong, or there is a system level failure that prevents the
    authentication request.
    
    Note that the USERNAME of the LOGIN may be different from the username
    you supplied and will reflect the system canonical username.
    
    See LOGIN (type)
    See LOGOUT

  • EXTERNAL GENERIC-FUNCTION

    LOGOUT

    • LOGIN

    Source

    Logs out the session and frees up any associated system resources.
    
    Safe to call multiple times.
    
    See LOGIN
    See LOGIN (type)

  • EXTERNAL GENERIC-FUNCTION

    MESSAGE

    • CONDITION

    The message supplied for the error.
    
    May give some idea on what went wrong -- or not!
    
    See AUTH-ERROR

  • EXTERNAL GENERIC-FUNCTION

    USERNAME

    • OBJECT

    Returns the username of the login.
    
    See LOGIN (type)

  • EXTERNAL GENERIC-FUNCTION

    (SETF USERNAME)

    • NEW-VALUE
    • OBJECT

    No documentation provided.