VMS Help  —  ENCRYPT Routine, ENCRYPT$DEFINE_KEY
    Places a key definition into the process, group, job, or system
    key storage table.

    Format

      ENCRYPT$DEFINE_KEY  key-name, key-value, key-flags

1  –  Arguments

 key-name

    type:      char_string
    access:    read only
    mechanism: by descriptor
    Name of the key defined when ENCRYPT$DEFINE_KEY completes
    execution. The key-name argument is the address of a string
    descriptor pointing to a char_string that is interpreted as the
    name of the key to be defined. A maximum of 243 characters is
    permitted.

                                   NOTE

       Key names beginning with ENCRYPT$ are reserved for VSI.

 key-value

    type:      char_string
    access:    read only
    mechanism: by descriptor
    Key value defined when ENCRYPT$DEFINE_KEY completes execution.
    The key-value argument is the address of a string descriptor
    pointing to a vector of unsigned byte values that are assigned to
    the named key. A maximum of 240 bytes may be assigned.

 key-flags

    type:      longword
    access:    read only
    mechanism: by reference
    Flags that ENCRYPT$DEFINE_KEY uses when defining a key. The key-
    flags argument is the address of a longword containing flags that
    control the key definition process.

    Each flag has a symbolic name. The constants associated with
    these names are defined in the ENCRYPT$EXAMPLES:ENCRYPT_
    STRUCTURES files in various programming languages.

    ENCRYPT$DEFINE_KEY Flags defines the function of each flag.

    Table 9-1 ENCRYPT$DEFINE_KEY Flags

    Flag                   Function

    Symbolic Name          Function

    ENCRYPT$M_KEY_PROCESS  Places definition in process table
    ENCRYPT$M_KEY_GROUP    Places definition in group table
    ENCRYPT$M_KEY_JOB      Places definition in job table
    ENCRYPT$M_KEY_SYSTEM   Places definition in system table
    ENCRYPT$M_KEY_LITERAL  Stores key without compressing
    ENCRYPT$M_KEY_AES      Designates an AES key value

    The following AES mask can be used in addition to (OR with) other
    flags for the key-flags parameter (as a longword by reference).
    An associated AES key value can be used for testing the bit
    within the program. Use the KEY_AES key flag to specify an AES
    key:

    o  ENCRYPT$M_KEY_AES

    o  ENCRYPT$V_KEY_AES
Close Help