HELPLIB.HLB  —  ENCRYPT  Qualifiers

1    /BACKUP

       /BACKUP[=time]

    Selects files according to the dates of their most recent backup.

    This qualifier is relevant only when used with the /BEFORE or the
    /SINCE qualifier. In addition, do not use /BACKUP with /EXPIRED
    or /MODIFIED.

    If you omit time, TODAY is used. For more information on time
    specifications, see the OpenVMS User's Manual.

2    /BEFORE

       /BEFORE[=time]

    Selects files that have a creation time before the time you
    specify.

    If you omit time, TODAY is used. For more information on time
    specifications, see the OpenVMS User's Manual.

3    /BY_OWNER

       /BY_OWNER[=uic]
       /NOBY_OWNER

    Selects files with the owner UIC you specify.

    If you omit uic, the UIC of the current process is used. For
    more information on specifying UIC format, see the OpenVMS User's
    Manual.

4    /COMPRESS

       /COMPRESS
       /NOCOMPRESS

    Optional. Default: /NOCOMPRESS.

    Controls whether or not data compression occurs before a file is
    encrypted.

5    /CONFIRM

       /CONFIRM
       /NOCONFIRM

    Controls whether or not a confirmation request is displayed
    before each encryption, as follows:

    Response         Meaning

    YES              Encrypts the file
    NO or <Return>   Does not encrypt the file (default)
    QUIT or          Does not encrypt the file or any subsequent
    <Ctrl/Z>         files
    ALL              Encrypts the file plus all subsequent files

6    /DATA_ALGORITHM

                        { DESCBC (default) }
       /DATA_ALGORITHM= { AESmmmkkk        }
                        {                  }

    Where mmm is the mode CBC, ECB, CFB, or OFB; and kkk is 128,
    192, or 256 bits. Cipher Block Chaining (CBC) and Electronic Code
    Book (ECB) are 16-byte block modes, meaning blocks are padded to
    16 bytes if necessary during encryption. The padding is removed
    during decryption. Cipher Feedback (CFB) and Output Feedback
    (OFB) are 8-bit character stream mode emulation, useful in data
    communications and where no padding is required.

    Note that /DATA_ALGORITM=AES is a shortcut for specifying
    AESCBC128.

    The data algorithm is used with the randomly generated key to
    perform encryption of the file's data. When specifying an AES
    algorithm, specify both /KEY and /DATA=AESmmmkkk qualifiers and
    use an AES created key.

7    /DELETE

       /DELETE
       /NODELETE

    Controls whether or not the input files are deleted after the
    encryption operation is complete and the output file is written
    and closed. By default, the input file is not deleted.

8    /ERASE

       /ERASE
       /NOERASE

    Controls whether or not the input files are erased with the data
    security pattern before being deleted. By default, the location
    in which the data was stored is not overwritten with the data
    security pattern. The /ERASE qualifier must be used with /DELETE.

9    /EXCLUDE

       /EXCLUDE=file-spec
       /NOEXCLUDE

    Excludes the specified files from the encryption operation. You
    can use wildcard characters. You do not need to enter an entire
    file specification. Any field that you omit defaults to the input
    file specification.

    Because directory files are never encrypted, you need not specify
    them.

10    /EXPIRED

       /EXPIRED[=time]

    Selects files according to the dates on which they expire.

    This qualifier is relevant only when used with the /BEFORE or the
    /SINCE qualifier. In addition, do not use /EXPIRED with /BACKUP
    or /MODIFIED.

    If you omit time, TODAY is used. For more information on time
    specifications, see the OpenVMS User's Manual.

11    /KEY_ALGORITHM

                       { DESCBC (default) }
       /KEY_ALGORITHM= { AESmmmkkk        }
                       {                  }

    Where mmm is the mode CBC, ECB, CFB, or OFB; and kkk is 128,
    192, or 256 bits. Note that /KEY_ALGORITHM=AES is a shortcut for
    specifying AESCBC128.

    The command uses this key algorithm with the key you supply
    to encrypt the randomly generated data encryption key and the
    initialization vector stored within the file.

    When specifying an AES algorithm, specify both /KEY and /DATA
    qualifiers and use an AES created key.

12    /MODIFIED

       /MODIFIED[=time]

    Selects files according to the dates on which they were last
    modified.

    This qualifier is relevant only when used with the /BEFORE or the
    /SINCE qualifier. In addition, do not use /MODIFIED with /BACKUP
    or /EXPIRED.

    If you omit time, TODAY is used. For more information on time
    specifications, see the OpenVMS User's Manual.

13    /OUTPUT

       /OUTPUT=file-spec

    Alternate output file name for the encryption operation. By
    default, each input file encrypted is written to a separate
    output file that is one version higher than the highest version
    of the input file. When using the /OUTPUT qualifier, specify the
    parts of the file specification different from the defaults. You
    do not need to provide an entire file specification. Any field
    that you omit defaults to the input file specification.

14    /SHOW

       /SHOW=keyword-list

    Controls whether or not the following information about the
    encryption operation is displayed on SYS$COMMAND:

    Keyword        Meaning

    FILES          Displays input and output file names on
                   SYS$COMMAND
    STATISTICS     Displays the encryption stream statistics:

                   o  Bytes processed

                   o  Internal records processed

                   o  CPU time consumed within the encryption
                      algorithm

15    /SINCE

       /SINCE[=time]

    Selects files that have a creation date before the time you
    specify.

    If you omit time, TODAY is used. For more information on time
    specifications, see the OpenVMS User's Manual.

16    /STATISTICS

    Similar to /SHOW, except that /STATISTICS lists both files and
    statistics, whereas /SHOW can be customized to list only one or
    the other.

17    /VERSION

    Displays the version number of the Encryption for OpenVMS
    software running on your system.
Close Help