Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.pki

Class EncryptionKey

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,EncryptionKey>

com.aoindustries.aoserv.client.CachedObject<Integer,EncryptionKey>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<EncryptionKey>

com.aoindustries.aoserv.client.pki.EncryptionKey

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,EncryptionKey>

public final class EncryptionKey
extends CachedObjectIntegerKey<EncryptionKey>

Stores the list of encryption keys for a business. The keys themselves are GPG keys and are stored by GPG.

Author:

AO Industries, Inc.

See Also:

• Account

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
EncryptionKey()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
String	decrypt(String ciphertext, String passphrase)	Uses the private key to decrypt the data and verifies the signature.
static String	decrypt(String recipient, String ciphertext, String passphrase)	Uses the provided private key to decrypt the data.
String	encrypt(EncryptionKey recipient, String plaintext)	Encrypts a message for the provided recipient and signs with the private key.
static String	encrypt(String signer, String recipient, String plaintext)	Uses the provided public key to encrypt the data.
Account	getAccount()
Account.Name	getAccount_name()
protected Object	getColumnImpl(int i)
String	getId()	Gets the id of the key use for GPG.
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode, toStringImpl

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EncryptionKey

@Deprecated(forRemoval=true)
public EncryptionKey()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

encrypt

public static String encrypt(String signer,
 String recipient,
 String plaintext)
                      throws IOException

Uses the provided public key to encrypt the data.

Throws:

IOException

decrypt

public static String decrypt(String recipient,
 String ciphertext,
 String passphrase)
                      throws IOException

Uses the provided private key to decrypt the data.

Throws:

IOException

getAccount_name

public Account.Name getAccount_name()

getAccount

public Account getAccount()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,EncryptionKey>

getId

public String getId()

Gets the id of the key use for GPG. The id must be unique per business.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,EncryptionKey>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,EncryptionKey>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,EncryptionKey>

Throws:

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,EncryptionKey>

Throws:

IOException

encrypt

public String encrypt(EncryptionKey recipient,
 String plaintext)
               throws IOException

Encrypts a message for the provided recipient and signs with the private key.

Throws:

IOException

decrypt

public String decrypt(String ciphertext,
 String passphrase)
               throws IOException

Uses the private key to decrypt the data and verifies the signature.

Throws:

IOException