pgpro_wrap
pgpro_wrap — скрыть код PL/pgSQL
Синтаксис
pgpro_wrap [-V | --version] [-? | --help]
Описание
pgpro_wrap — утилита командной строки, предназначенная для защиты кода PL/pgSQL от несанкционированного просмотра и изменений. Она преобразует хранимые процедуры и функции в скрытую (обфусцированную) форму. Сервер баз данных может по-прежнему выполнять эти процедуры и функции, но их код нельзя просмотреть напрямую в системных каталогах.
Возможность создания и выполнения обфусцированных объектов управляется параметром конфигурации pgpro_wrap.
Использование
Обычно работа с утилитой включает несколько этапов. Сначала функция или процедура PL/pgSQL должна быть записана в обычный текстовый файл с кодировкой UTF-8. Затем pgpro_wrap обрабатывает этот файл и создаёт файл с суффиксом .wrap. Полученный файл загружается в базу данных с помощью утилиты psql. Сервер базы данных автоматически обрабатывает код и создаёт соответствующий хранимый объект. В результате функция или процедура выполняется обычным образом без дополнительных действий.
При попытке просмотреть или изменить исходный код таких объектов напрямую с помощью клиентских инструментов, например pgAdmin, либо через системный каталог pg_proc, отображается только скрытая версия кода. Однако если во время выполнения обфусцированного объекта возникает ошибка, сообщение об ошибке включает ошибочную строку в открытом виде. Это необходимо для отладки.
Пример использования
Подготовьте текстовый файл в кодировке UTF‑8, содержащий функцию или процедуру PL/pgSQL.
Обработайте исходный файл утилитой pgpro_wrap:
pgpro_wrap
исходный_файлУтилита создаёт в текущем каталоге выходной файл с именем
. Если файл с таким именем уже существует, pgpro_wrap завершает работу с ошибкой, предотвращая случайную перезапись.исходный_файл.wrapЗагрузите полученный файл в базу данных с помощью psql:
psql -d
имя_базы_данных-fисходный_файл.wrapСервер базы данных автоматически обрабатывает код и создаёт соответствующий хранимый объект.
Убедитесь, что хранимый объект работает ожидаемым образом, например, выполнив его.
Попробуйте просмотреть исходный код созданного объекта, например, с помощью команды \df+ в psql. Вместо исходного текста отобразится только обфусцированная версия.
Параметры
pgpro_wrap принимает следующие аргументы командной строки:
-V--versionВывести версию pgpro_wrap и завершить работу.
-?--helpПоказать справку по pgpro_wrap и завершить работу.
Примечания
Учтите, что скрытый код PL/pgSQL отображается в виде обычного текста в следующих компонентах системы:
файлы журналов сервера
журналы pg_proaudit
статистика, собранная с помощью pg_stat_statements и pgpro_stats
данные, предоставляемые модулем auto_explain
Таким образом, pgpro_wrap эффективно предотвращает случайный просмотр и прямое редактирование исходного кода PL/pgSQL через системные каталоги и клиентские инструменты. Однако в указанных выше диагностических контекстах исходный код всё ещё может появляться в открытом виде. Это важное свойство средств мониторинга и отладки, а не ограничение утилиты.
pgpro_wrap
pgpro_wrap — obfuscate PL/pgSQL code
Synopsis
pgpro_wrap [ -V | --version ] [ -? | --help ]
Description
pgpro_wrap is a command-line utility designed to protect the PL/pgSQL code from unauthorized viewing and modification. It transforms stored procedures and functions into an obfuscated form that remains executable by the database server but cannot be easily viewed in the system catalogs.
Creation and execution of obfuscated objects is controlled by the pgpro_wrap configuration parameter.
Usage
A typical usage workflow consists of several steps. First, a PL/pgSQL function or procedure is written in a plain text file, which must be encoded in UTF-8. This file is then processed by pgpro_wrap, which produces an output file with the .wrap suffix. The output file is subsequently loaded into the database using the psql utility. The database server automatically processes the code and creates the corresponding stored object. The resulting function or procedure is then executed normally without any additional steps.
When an attempt is made to view or edit the source code of such objects directly using client tools such as pgAdmin or through the pg_proc system catalog, only the obfuscated representation is displayed. However, if an error occurs during the execution of an obfuscated object, the error message includes the failing line in plain text. This is necessary for debugging purposes.
Usage Example
Prepare a plain text file in UTF‑8 encoding containing the PL/pgSQL function or procedure.
Obfuscate the source file using pgpro_wrap:
pgpro_wrap
source_fileThe utility creates an output file named
in the current directory. If a file with that name already exists, pgpro_wrap exits with an error to prevent accidental overwriting.source_file.wrapLoad the obfuscated file into the database using psql:
psql -d
database_name-fsource_file.wrapThe database server automatically processes the code and creates the corresponding stored object.
Verify that the stored object behaves as expected, for example by executing it.
Attempt to view the source code of the created object, for example, with \df+ in psql. Only the obfuscated representation is displayed, not the original plain text.
Options
pgpro_wrap accepts the following command-line arguments:
-V--versionPrint the pgpro_wrap version and exit.
-?--helpShow help about pgpro_wrap and exit.
Notes
Be aware that the obfuscated PL/pgSQL code is displayed in plain text in the following system components:
server log files
pg_proaudit logs
statistics collected by pg_stat_statements and pgpro_stats
data provided by auto_explain
Thus, pgpro_wrap effectively prevents casual viewing and direct editing of the PL/pgSQL source code through system catalogs and client tools. However, the source code may still appear in plain text in the diagnostic contexts listed above. This is an essential property of monitoring and debugging facilities, not a limitation of the utility.