[ru]
Введение
Rutoken PKCS#11 Spy предназначен для логгирования вызовов библиотеки Rutoken PKCS#11.
Документация по продуктам Рутокен доступна на сайте http://www.rutoken.ru/
Поддержка осуществляется по электронной почте hotline@rutoken.ru

Использование
Для использования Rutoken PKCS#11 Spy необходимо выполнить следующие действия:
1. Завершить приложения, использующие библиотеку PKCS#11, вызовы которой требуется логгировать.
2. Подменить библиотеку PKCS#11 (Rutoken PKCS#11 ECP или Rutoken PKCS#11) библиотекой Rutoken PKCS#11 Spy (rtpkcs11-spy.dll, librtpkcs11-spy.so, librtpkcs11-spy.dylib, в зависомости от платформы).
3. Определить следующие переменные окружения:
	RT_PKCS11SPY_OUTPUT - путь до файла, в который будет осуществляться логгирование вызовов;
	RT_PKCS11SPY - путь до оригинальной библиотеки PKCS#11.
4. Запустить приложение, использующее библиотеку PKCS#11.

Пример последовательности действий в виде batch-файла:
set RT_PKCS11SPY_OUTPUT=C:\pkcs11-spy\pkcs11-spy.log
set RT_PKCS11SPY=C:\Windows\System32\rtPKCS11ECP_orig.dll
copy C:\Windows\system32\rtPKCS11ECP.dll C:\Windows\system32\rtPKCS11ECP_orig.dll
copy rtpkcs11-spy.dll C:\Windows\system32\rtPKCS11ECP.dll

В ОС Windows, в случае если библиотека Rutoken PKCS#11 ECP установлена вместе с Драйверами Рутокен, для использования Rutoken PKCS#11 Spy можно воспользоваться batch-скриптом InstallSpy-windows-x86.bat для 32-битных ОС Windows и InstallSpy-windows-x86_64.bat для 64-битных ОС Windows.
Логгирование в этом случае будет осуществляться в файл %TEMP%\rtpkcs11-spy.log.

Удалить библиотеку логгирования можно выполнив скрипт UninstallSpy-windows-x86.bat для 32-битных ОС Windows и UninstallSpy-windows-x86_64.bat для 64-битных ОС Windows.

В Mac OS, в случае если библиотека Rutoken PKCS#11 ECP установлена вместе с Модулем поддержки Связки Ключей (KeyChain),  для использования Rutoken PKCS#11 Spy можно воспользоваться скриптом InstallSpyMacOs.sh. Выполните следующую последовательность действий:
1. Отключите все токены, подключенные к компьютеру.
2. Поместите файл скрипта InstallSpyMacOs.sh в одной директории с файлом librtpkcs11-spy.dylib
3. Запустите скрипт InstallSpyMacOs.sh с root-правами.
4. Перезагрузите компьютер.
В результате действий будет заменена библиотека librtpkcs11ecp.dylib по пути "Library/Aktiv Co/Rutoken ECP/lib/". Логгирование будет осуществляться в файл "/Library/Logs/rutoken/pkcs11spy/log.log".
Скрипт InstallSpyMacOs.sh позволяет также обеспечить установку Rutoken PKCS#11 Spy, в случае если требуется специфицировать пути до библиотеки PKCS#11 и до файла с логом. Доступны следующие опции скрипта InstallSpyMacOs.sh:
	-u	Удалить Rutoken PKCS#11 Spy. Если Rutoken PKCS#11 Spy был установлен с указанием специальных путей до файла лога и до библиотеки PKCS#11, необходимо указать их же при выборе данной опции.

	-o output_file
		Указать специальный путь для файла лога.

	-l library_file
		Указать специальный путь до библиотеки PKCS#11.

Лицензионные обязательства
Этот продукт является производным от OpenSC PKCS#11 Spy, который распространяется по лицензии LGPL версии 2.1 или более поздней версии.
Этот продукт распространяется по лицензии LGPL версии 2.1 или более поздней версии. Копия лицензии размещена в файле "COPYING" в той же директории, что и этот файл. Исходный код продукта доступен по адресу https://github.com/AktivCo/rutoken-pkcs11-spy.
Официальное название PKCS#11 -- "RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki)".
Исходный код Rutoken PKCS#11 Spy использует официальные заголовки PKCS#11 версии 2.30 и поэтому "является производным от RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki)".



[en]
Rutoken PKCS#11 Spy is a tool for logging Rutoken PKCS#11 library calls.

Rutoken documentation is available online at
    http://www.rutoken.ru/

Rutoken Technical Support
    hotline@rutoken.ru

Registration for all OS:

Create environment variables:
    RT_PKCS11SPY_OUTPUT - path to log file
    RT_PKCS11SPY - path to real Rutoken PKCS#11 library

        
Installation on Windows only:
    run "InstallSpy-windows-x86.bat"
    or
    run "InstallSpy-windows-x86_64.bat"
    
Uninstallation on Windows only:    
    run "UninstallSpy-windows-x86.bat"
    or 
    run "UninstallSpy-windows-x86_64.bat"
    
        
Registration on macOS only:
	Script "InstallSpyMacOs.sh" can help you install Spy for "Rutoken PKCS#11" library. You should run it in the folder with "librtpkcs11-spy.dylib" library file.

	IMPORTANT: script should be launched as root user.

	The script launch without any arguments will install Spy into directory "/Library/Aktiv Co/Rutoken ECP/lib" and write log data to file "/Library/Logs/rutoken/pkcs11spy/log.log".

	IMPORTANT: before installation detach every token and after installation PC reboot is required.

The following options are available:

	-u	Uninstalls Spy. If you installed Spy into specific path, you should similarly specify path to it.

	-o output_file
		Specifies a file, where Spy will write logs.

	-l library_file
		Specifies "Rutoken PKCS#11" library.
 
License issues
This product is derived from OpenSC PKCS#11 Spy, that is licensed as Open Source software under the LGPL license version 2.1 of the License, or (at your option) any later version. This product is licensed under the LGPL license version 2.1 of the License, or (at your option) any later version. A copy of the license is included in file "COPYING", under the same directory as this file. Corresponding source code can be found at https://github.com/AktivCo/rutoken-pkcs11-spy.
The official name for PKCS#11 is "RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki)".
Rutoken PKCS#11 Spy source code includes the official header files (version 2.30) and thus is "derived from the RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki)".
