Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
Gpg Module Documentation
The Gpg module allows users to create and manage GnuPG keys. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.Gpg::number_of_private_keys
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve the number of private GPG keys installed for a user. |
| Returns: | |
<data> <count> An integer value that contains the number of GPG private keys.</count> </data> |
Gpg::listgpgkeys
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List public GPG keys installed for the user. |
| Returns: | |
<data> <bits> A string value that contains the length of the key in bits. (e.g. 1024D)</bits> <keyid> A string value that contains the key ID.</keyid> <id> A string value that contains the key ID.</id> <date> A string value that contains the date the key was created.</date> <key> A string value that contains any identifying characteristics of key. (e.g. 'keyid [1024D] name_of_key (short name) (email@example.com)')</key> <type> A string value that contains 'pub' if the key is public.</type> <email> A string value that contains the email address encoded in the key.</email> <name> A string value that contains long and short names of the key.</name> </data> |
Gpg::number_of_public_keys
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve the number of public GPG keys installed for a user. You must have access to the 'gpg' feature to use this function. |
| Returns: | |
<data> <count> An integer value that contains the number of public GPG keys.</count> </data> |
Gpg::listsecretgpgkeys
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List GPG private (secret) keys associated with a user. |
| Returns: | |
<data> <bits> A string value that contains the length of the key in bits. (e.g. 1024D)</bits> <keyid> A string value that contains the key ID.</keyid> <id> A string value that contains the key ID.</id> <date> A string value that contains the date of the key's creation.</date> <key> A string value that contains any identifying characteristics of the key. (e.g. 'keyid [1024D] name_of_key (short name) (email@example.com)')</key> <type> A string value that will contain 'sec' if the key is private.</type> <email> A string value that contains the email address encoded in the key.</email> <name> A string value that contains both the long and short names of key.</name> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 26 Mar 2012 - 16:02:59 - Main.JenniferDoubrava