F.42. sslinfo — получение информации об SSL-сертификате клиента #
Модуль sslinfo выдаёт информацию о SSL-сертификате, который был представлен текущим клиентом при подключении к PostgreSQL. Этот модуль бесполезен (большинство функций возвратят NULL), если для текущего подключения не задействуется SSL.
Часть информации, выдаваемой этим модулем, можно получить через встроенное системное представление pg_stat_ssl.
Это расширение не будет собираться, если конфигурация была произведена без ключа --with-ssl=openssl.
F.42.1. Предоставляемые функции #
-
ssl_is_used() returns boolean Возвращает true, если текущее подключение использует SSL, и false в противном случае.
-
ssl_version() returns text Возвращает имя протокола, по которому организовано SSL-подключение (например TLSv1.0, TLSv1.1, TLSv1.2 или TLSv1.3).
-
ssl_cipher() returns text Возвращает имя шифра, используемого для SSL-подключения (например, DHE-RSA-AES256-SHA).
-
ssl_client_cert_present() returns boolean Возвращает true, если текущий клиент предоставил серверу действительный клиентский SSL-сертификат, и false в противном случае. (Сервер может требовать, а может и не требовать предоставления клиентского сертификата.)
-
ssl_client_serial() returns numeric Возвращает серийный номер текущего клиентского сертификата. Сочетание серийного номера сертификата с выдавшим его центром сертификации гарантирует однозначную идентификацию сертификата (но не его владелец — владелец должен регулярно менять свои ключи и получать сертификаты в центре сертификации).
Поэтому, если вы используете собственный ЦС и настроили сервер, чтобы он принимал сертификаты только от этого ЦС, серийный номер будет наиболее надёжным (хотя не очень запоминающимся) ключом идентификации пользователя.
-
ssl_client_dn() returns text Возвращает полное имя субъекта из текущего клиентского сертификата, преобразуя символьные данные в кодировку текущей базы данных. Предполагается, что если в именах в сертификатах используются символы вне таблицы ASCII, то ваша база данных может представить эти символы. Если в вашей базе используется кодировка SQL_ASCII, символы вне ASCII в имени будут представлены последовательностями UTF-8.
Результат выглядит примерно так:
/CN=Somebody /C=Some country/O=Some organization.-
ssl_issuer_dn() returns text Возвращает полное имя издателя текущего клиентского сертификата, преобразуя символьные данные в кодировку текущей базы данных. Преобразования кодировки осуществляются так же, как и в
ssl_client_dn.Сочетание возвращаемого значения этой функции с серийным номером сертификата однозначно идентифицирует сертификат.
Эта функция полезна, только если в установленном на сервере файле с сертификатами ЦС содержатся сертификаты нескольких ЦС или если один ЦС выдаёт сертификаты для промежуточных центров сертификации.
-
ssl_client_dn_field(fieldname text) returns text Эта функция возвращает значение указанного поля данных субъекта сертификата, либо NULL, если это поле отсутствует. Имена полей задаются строковыми константами, которые затем преобразуются в идентификаторы объектов ASN1, используя базу данных объектов OpenSSL. Принимаются следующие значения:
commonName (или CN) surname (или SN) name givenName (или GN) countryName (или C) localityName (или L) stateOrProvinceName (или ST) organizationName (или O) organizationalUnitName (или OU) title description initials postalCode streetAddress generationQualifier description dnQualifier x500UniqueIdentifier pseudonym role emailAddress
Все эти поля являются необязательными, за исключением
commonName. Какие из них будут включены в сертификат, а какие нет, зависит полностью от политики вашего ЦС. Значение этих полей, однако, строго определено стандартами X.500 и X.509, так что их нельзя интерпретировать произвольным образом.-
ssl_issuer_field(fieldname text) returns text То же, что
ssl_client_dn_field, но для издателя, а не для субъекта сертификата.-
ssl_extension_info() returns setof record Предоставляет информацию о расширениях клиентского сертификата: имя расширения, значение расширения и является ли это расширение критическим.
F.42.2. Автор #
Виктор Вагнер <vitus@cryptocom.ru>, ООО «Криптоком»
Дмитрий Воронин <carriingfate92@yandex.ru>
Электронный адрес группы разработчиков OpenSSL в Криптокоме: <openssl@cryptocom.ru>
F.42. sslinfo — obtain client SSL information #
The sslinfo module provides information about the SSL certificate that the current client provided when connecting to PostgreSQL. The module is useless (most functions will return NULL) if the current connection does not use SSL.
Some of the information available through this module can also be obtained using the built-in system view pg_stat_ssl.
This extension won't build at all unless the installation was configured with --with-ssl=openssl.
F.42.1. Functions Provided #
-
ssl_is_used() returns boolean Returns true if current connection to server uses SSL, and false otherwise.
-
ssl_version() returns text Returns the name of the protocol used for the SSL connection (e.g., TLSv1.0, TLSv1.1, TLSv1.2 or TLSv1.3).
-
ssl_cipher() returns text Returns the name of the cipher used for the SSL connection (e.g., DHE-RSA-AES256-SHA).
-
ssl_client_cert_present() returns boolean Returns true if current client has presented a valid SSL client certificate to the server, and false otherwise. (The server might or might not be configured to require a client certificate.)
-
ssl_client_serial() returns numeric Returns serial number of current client certificate. The combination of certificate serial number and certificate issuer is guaranteed to uniquely identify a certificate (but not its owner — the owner ought to regularly change their keys, and get new certificates from the issuer).
So, if you run your own CA and allow only certificates from this CA to be accepted by the server, the serial number is the most reliable (albeit not very mnemonic) means to identify a user.
-
ssl_client_dn() returns text Returns the full subject of the current client certificate, converting character data into the current database encoding. It is assumed that if you use non-ASCII characters in the certificate names, your database is able to represent these characters, too. If your database uses the SQL_ASCII encoding, non-ASCII characters in the name will be represented as UTF-8 sequences.
The result looks like
/CN=Somebody /C=Some country/O=Some organization.-
ssl_issuer_dn() returns text Returns the full issuer name of the current client certificate, converting character data into the current database encoding. Encoding conversions are handled the same as for
ssl_client_dn.The combination of the return value of this function with the certificate serial number uniquely identifies the certificate.
This function is really useful only if you have more than one trusted CA certificate in your server's certificate authority file, or if this CA has issued some intermediate certificate authority certificates.
-
ssl_client_dn_field(fieldname text) returns text This function returns the value of the specified field in the certificate subject, or NULL if the field is not present. Field names are string constants that are converted into ASN1 object identifiers using the OpenSSL object database. The following values are acceptable:
commonName (alias CN) surname (alias SN) name givenName (alias GN) countryName (alias C) localityName (alias L) stateOrProvinceName (alias ST) organizationName (alias O) organizationalUnitName (alias OU) title description initials postalCode streetAddress generationQualifier description dnQualifier x500UniqueIdentifier pseudonym role emailAddress
All of these fields are optional, except
commonName. It depends entirely on your CA's policy which of them would be included and which wouldn't. The meaning of these fields, however, is strictly defined by the X.500 and X.509 standards, so you cannot just assign arbitrary meaning to them.-
ssl_issuer_field(fieldname text) returns text Same as
ssl_client_dn_field, but for the certificate issuer rather than the certificate subject.-
ssl_extension_info() returns setof record Provide information about extensions of client certificate: extension name, extension value, and if it is a critical extension.
F.42.2. Author #
Victor Wagner <vitus@cryptocom.ru>, Cryptocom LTD
Dmitry Voronin <carriingfate92@yandex.ru>
E-Mail of Cryptocom OpenSSL development group: <openssl@cryptocom.ru>