GPG Keys

A GPGKey object on Files.com is used to securely store both the private and public keys associated with a GPG (GNU Privacy Guard) encryption key pair. This object enables the encryption and decryption of data using GPG, allowing you to protect sensitive information.

The private key is kept confidential and is used for decrypting data or signing messages to prove authenticity, while the public key is used to encrypt messages that only the owner of the private key can decrypt.

By storing both keys together in a GPGKey object, Files.com makes it easier to understand encryption operations, ensuring secure and efficient handling of encrypted data within the platform.

List GPG Keys

SDK Method

\Files\Model\GpgKey::list;

Return Object

GpgKey[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

try {
  $gpg_keys = \Files\Model\GpgKey::list([
    'user_id' => 1
  ]);
  foreach ($gpg_keys as $gpg_key) {
    // Operate on $gpg_key
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show GPG Key

SDK Method

\Files\Model\GpgKey::find;

Return Object

GpgKey

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Gpg Key ID.

Example Request

try {
  $gpg_key = \Files\Model\GpgKey::find($id);
  // Operate on $gpg_key
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create GPG Key

SDK Method

\Files\Model\GpgKey::create;

Return Object

GpgKey

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

ArgumentDefaultDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
partner_id
int64		Partner ID who owns this GPG Key, if applicable.
public_key
string		The GPG public key
private_key
string		The GPG private key
private_key_password
string		The GPG private key password
name
string
Required		GPG key name.
workspace_id
int64		0Workspace ID (0 for default workspace).
generate_expires_at
string		Expiration date of the key. Used for the generation of the key. Will be ignored if generate_keypair is false.
generate_keypair
boolean		If true, generate a new GPG key pair. Can not be used with public_key/private_key
generate_full_name
string		Full name of the key owner. Used for the generation of the key. Will be ignored if generate_keypair is false.
generate_email
string		Email address of the key owner. Used for the generation of the key. Will be ignored if generate_keypair is false.

Example Request

try {
  $gpg_key = \Files\Model\GpgKey::create([
    'name' => "key name"
  ]);
  // Operate on $gpg_key
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Update GPG Key

SDK Method

$gpg_key->update;

Return Object

GpgKey

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

ArgumentDescription
partner_id
int64		Partner ID who owns this GPG Key, if applicable.
public_key
string		The GPG public key
private_key
string		The GPG private key
private_key_password
string		The GPG private key password
name
string		GPG key name.

Example Request

try {
  // Find the gpg_key object by its id.
  $gpg_key = \Files\Model\GpgKey::find(id);
  $gpg_key->update([
    'partner_id' => 1
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Delete GPG Key

SDK Method

$gpg_key->delete;

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Example Request

try {
  // Find the gpg_key object by its id.
  $gpg_key = \Files\Model\GpgKey::find(id);
  $gpg_key->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The GpgKey Object

Some of the methods above return a GpgKey object. The attributes of this object are listed below.

AttributeDescription
id
int64		GPG key ID.
workspace_id
int64		Workspace ID (0 for default workspace).
expires_at
date-time		GPG key expiration date.
name
string		GPG key name.
partner_id
int64		Partner ID who owns this GPG Key, if applicable.
partner_name
string		Name of the Partner who owns this GPG Key, if applicable.
user_id
int64		User ID who owns this GPG Key, if applicable.
public_key_md5
string		MD5 hash of the GPG public key
private_key_md5
string		MD5 hash of the GPG private key.
generated_public_key
string		GPG public key
generated_private_key
string		GPG private key.
private_key_password_md5
string		GPG private key password. Only required for password protected keys.