MogDB
Ecological Tools
Doc Menu

Security Functions

  • gs_encrypt_aes128(encryptstr,keystr)

    Description: Encrypts encryptstr strings using keystr as the key and returns encrypted strings. The length of keystr ranges from 1 to 16 bytes. Currently, the following types of data can be encrypted: numerals supported in the database; character type; RAW in binary type; and DATE, TIMESTAMP, and SMALLDATETIME in date/time type.

    Return type: text

    Length of the return value: At least 92 bytes and no more than (4[Len/3]+68) bytes, where Len* indicates the length of the data before encryption (unit: byte).

    Example:

    mogdb=# SELECT gs_encrypt_aes128('MPPDB','1234');
        
                                   gs_encrypt_aes128
    -------------------------------------------------------------------------------------
    gwditQLQG8NhFw4OuoKhhQJoXojhFlYkjeG0aYdSCtLCnIUgkNwvYI04KbuhmcGZp8jWizBdR1vU9CspjuzI0lbz12A=
    (1 row)

    img NOTE: A decryption password is required during the execution of this function. For security purposes, the gsql tool does not record the function in the execution history. That is, the execution history of this function cannot be found in gsql by paging up and down.

  • gs_decrypt_aes128(decryptstr,keystr)

    Description: Decrypts decrypt strings using keystr as the key and returns decrypted strings. The keystr used for decryption must be consistent with that used for encryption. keystr cannot be empty.

    img NOTE: This parameter needs to be used with the gs_encrypt_aes128 encryption function.

    Return type: text

    Example:

    mogdb=# SELECT gs_decrypt_aes128('gwditQLQG8NhFw4OuoKhhQJoXojhFlYkjeG0aYdSCtLCnIUgkNwvYI04KbuhmcGZp8jWizBdR1vU9CspjuzI0lbz12A=','1234');
     gs_decrypt_aes128 
    -------------------
     MPPDB
    (1 row)

    img NOTE: A decryption password is required during the execution of this function. For security purposes, the gsql tool does not record the function in the execution history. That is, the execution history of this function cannot be found in gsql by paging up and down.

  • gs_password_deadline

    Description: Indicates the number of remaining days before the password of the current user expires.

    Return type: interval

    Example:

    mogdb=# SELECT gs_password_deadline();
      gs_password_deadline   
    -------------------------
     83 days 17:44:32.196094
    (1 row)
  • gs_password_notifytime

    Description: Displays the number of remaining days notified before the password of the current user expires.

    Return type: int32

  • login_audit_messages

    Description: Queries login information about a login user.

    Return type: tuple

    Example:

    • Checking the date, time, and IP address successfully authenticated during the last login.

      mogdb=# SELECT * FROM login_audit_messages(true);
        username  | database |       logintime        |     type      | result |  client_conninfo   
      ------------+----------+------------------------+---------------+--------+--------------------
           omm    | mogdb | 2017-06-02 15:28:34+08 | login_success | ok     | gsql@[local]
      (1 row)
    • Checking the date, time, and IP address that failed to be authenticated during the last login.

      mogdb=# SELECT * FROM login_audit_messages(false) ORDER BY logintime desc limit 1;
        username  | database |       logintime        |     type     | result |     client_conninfo     
      ------------+----------+------------------------+--------------+--------+-------------------------
      (0 rows)
    • Checking the number of failed attempts, date, and time since the previous successful authentication.

      mogdb=# SELECT * FROM login_audit_messages(false);
        username  | database |       logintime        |     type     | result |     client_conninfo     
      ------------+----------+------------------------+--------------+--------+-------------------------
      (0 rows)
  • login_audit_messages_pid

    Description: Queries login information about a login user. Different from login_audit_messages, this function queries login information based on backendid. Information about subsequent logins of the same user does not alter the query result of previous logins and cannot be found using this function.

    Return type: tuple

    Example:

    • Checking the date, time, and IP address successfully authenticated during the last login.

      mogdb=# SELECT * FROM login_audit_messages(true);
        username  | database |       logintime        |     type      | result |  client_conninfo | backendid
      ------------+----------+------------------------+---------------+--------+--------------------
           omm    | mogdb | 2017-06-02 15:28:34+08 | login_success | ok     | gsql@[local] | 140311900702464
      (1 row)
    • Checking the date, time, and IP address that failed to be authenticated during the last login.

      mogdb=# SELECT * FROM login_audit_messages(false) ORDER BY logintime desc limit 1;
        username  | database |       logintime        |     type     | result |     client_conninfo   | backendid
      ------------+----------+------------------------+--------------+--------+-------------------------
      (0 rows)
    • Checking the number of failed attempts, date, and time since the previous successful authentication.

      mogdb=# SELECT * FROM login_audit_messages(false);
        username  | database |       logintime        |     type     | result |     client_conninfo    | backendid
      ------------+----------+------------------------+--------------+--------+-------------------------
      (0 rows)
  • inet_server_addr

    Description: Displays the server IP address.

    Return type: inet

    Example:

    mogdb=# SELECT inet_server_addr();
     inet_server_addr
    ------------------
     10.10.0.13
    (1 row)

    img NOTE:

    • The client IP address 10.10.0.50 and server IP address 10.10.0.13 are used as an example.
    • If the database is connected to the local PC, the value is empty.
  • inet_client_addr

    Description: Displays the client IP address.

    Return type: inet

    Example:

    mogdb=# SELECT inet_client_addr();
     inet_client_addr
    ------------------
     10.10.0.50
    (1 row)

    img NOTE:

    • The client IP address 10.10.0.50 and server IP address 10.10.0.13 are used as an example.
    • If the database is connected to the local PC, the value is empty.
  • pg_query_audit

    Description: Views audit logs of the primary database node.

    Return type: record

    The following table describes return fields.

    Name Type Description
    time timestamp with time zone Operation time
    type text Operation
    result text Operation result
    username text Name of the user who performs the operation
    database text Database name
    client_conninfo text Client connection information
    object_name text Object name
    detail_info text Operation details
    node_name text Node name
    thread_id text Thread ID
    local_port text Local port
    remote_port text Remote port

    For details about how to use the function and details about function examples, see Querying Audit Results.

  • pg_delete_audit

    Description: Deletes audit logs in a specified period.

    Return value type: void

    For details about how to use the function and details about function examples, see Maintaining Audit Logs.