API Reference
This page provides the complete API documentation for the RobotFrameworkPGP library.
RobotFrameworkPGP Class
- class RobotFrameworkPGP.pgp_library.RobotFrameworkPGP(gnupg_home=None)[source]
Bases:
KeyManagementMixin,EncryptionMixin,SigningMixin,InfoMixin,_BaseRobot Framework library for PGP/GPG encryption and decryption operations.
This library provides keywords for: - Text and file encryption/decryption - Key generation and management - Digital signatures - GPG operations
= Table of contents =
Initialization
Configuration
Encryption and Decryption
Key Management
Digital Signatures
Utility Keywords
= Initialization =
The library can be imported with optional parameters:
Library | RobotFrameworkPGP |Library | RobotFrameworkPGP | gnupg_home=/path/to/gnupg |= Configuration =
Before using encryption/decryption operations, you need to configure the GPG environment.
= Examples =
Set GPG Home Directory | /tmp/gnupg |Generate Key Pair | test@example.com | Test User | 2048 |${encrypted} | Encrypt Text | Hello World | test@example.com |${decrypted} | Decrypt Text | ${encrypted} | passphrase=secret |- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
- ROBOT_LIBRARY_VERSION = '1.1.2'
- ROBOT_LIBRARY_DOC_FORMAT = 'ROBOT'
- ROBOT_AUTO_KEYWORDS = False
Module Contents
Robot Framework library for PGP/GPG encryption and decryption operations.
- class RobotFrameworkPGP.RobotFrameworkPGP(gnupg_home=None)[source]
Bases:
KeyManagementMixin,EncryptionMixin,SigningMixin,InfoMixin,_BaseRobot Framework library for PGP/GPG encryption and decryption operations.
This library provides keywords for: - Text and file encryption/decryption - Key generation and management - Digital signatures - GPG operations
= Table of contents =
Initialization
Configuration
Encryption and Decryption
Key Management
Digital Signatures
Utility Keywords
= Initialization =
The library can be imported with optional parameters:
Library | RobotFrameworkPGP |Library | RobotFrameworkPGP | gnupg_home=/path/to/gnupg |= Configuration =
Before using encryption/decryption operations, you need to configure the GPG environment.
= Examples =
Set GPG Home Directory | /tmp/gnupg |Generate Key Pair | test@example.com | Test User | 2048 |${encrypted} | Encrypt Text | Hello World | test@example.com |${decrypted} | Decrypt Text | ${encrypted} | passphrase=secret |- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
- ROBOT_LIBRARY_VERSION = '1.1.2'
- ROBOT_LIBRARY_DOC_FORMAT = 'ROBOT'
- ROBOT_AUTO_KEYWORDS = False