PolarDB Always-confidential に付属の専用の Encrypted JDBC (EncJDBC) ドライバーを使用すると、コードを変更することなく Java アプリケーションと連携できます。EncJDBC は自動的に暗号文を復号し、プレーンテキストデータを返します。このプロセスはアプリケーションに対して透過的であり、いくつかの設定変更のみで PolarDB Always-confidential に接続できます。
ソリューションアーキテクチャ
PolarDB Always-confidential は、データベースプロキシを利用した、オンザフライ暗号化および復号ソリューションです。プロキシは、クエリの 結果セット をクライアントに返す際に、事前に設定された機密フィールドを暗号化します。クライアントアプリケーションは、専用の EncJDBC ドライバーを使用して、受信したデータを透過的に復号する必要があります。
ワークフローとロールの権限:
-
クエリ:クライアントアプリケーションは、EncJDBC ドライバーを介して、標準の SQL クエリを PolarDB の クラスターエンドポイントに送信します。
-
プロキシ処理:データベースプロキシはリクエストを受信し、実行のためにバックエンドのデータベースカーネルに転送します。
-
オンザフライ暗号化:クエリ結果を返す際、プロキシレイヤーは、事前に設定された暗号化ポリシーに一致するかどうかをチェックします。一致する場合、プロキシは、お客様が Key Management Service (KMS) から指定したキー、または 自己管理キー を使用して、結果セット 内の機密フィールドを暗号化します。
-
データ返却:暗号化された 結果セット がクライアントに返されます。
-
透過的な復号:クライアント側の EncJDBC ドライバーが自動的に暗号文を復号します。アプリケーションはプレーンテキストデータを受け取り、プロセス全体がビジネスコードに対して透過的になります。
クエリ結果は、データベースアカウントのロールによって異なります:
-
スーパー管理者:クエリ結果は常にプレーンテキストであり、暗号化ポリシーの影響を受けません。これは、データベースの管理や監査に役立ちます。
-
一般ユーザー:クエリ結果は暗号文として返されます。クライアントでデータを復号するには、EncJDBC ドライバーと正しい キー を使用する必要があります。
-
その他のユーザー:クエリ結果は暗号文として返され、復号することはできません。
制限事項
先に進む前に、以下の主要な制限事項を確認し、このソリューションがお客様のビジネスおよび技術要件を満たしているかどうかを判断してください。
-
エンドポイント要件:暗号化ルールは、クラスターエンドポイント または カスタムエンドポイント に接続した場合にのみ適用されます。プライマリエンドポイント に直接接続するとプロキシがバイパスされ、暗号化機能が無効になります。
-
キー管理:自己管理キー を使用する場合、キー のローテーションはサポートされず、キーの紛失 や キーの漏洩 のリスクがあります。キー を紛失した場合、対応する暗号化データを復号することはできません。キー を管理するためには、厳格なセキュリティ手順を確立する必要があります。
-
JDK バージョン:JDK バージョン 1.8 以降を使用する必要があります。
KMS キーの利用
ステップ 1:KMS アクセス権限の設定
-
アクセスキーペアの取得:RAM ユーザー の
アクセスキー IDとアクセスキーシークレットを取得します。これにより、アプリケーションから Key Management Service (KMS) が管理する マスター暗号化キー (MEK) を取得できるようになります。-
KMS へのアクセス権限を持つ適切な RAM ユーザー が既にある場合は、そのユーザーを使用できます。
-
適切な RAM ユーザー がいない場合は、RAM コンソール に移動します。左側メニューで、[ID 管理] > [ユーザー] を選択します。[ユーザーの作成] をクリックし、画面の指示に従ってユーザーを作成します。
-
-
RAM ユーザーへの権限付与:
-
RAM コンソール に移動します。左側メニューで、[権限管理] > [ポリシー] を選択します。[ポリシーの作成] をクリックします。[JSON] タブに切り替え、次の内容をコピーし、OK をクリックします。名前を入力してポリシーを作成します。
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": "KMS:Decrypt", "Resource": "*" } ] } -
RAM コンソール に戻ります。左側メニューで、[ID 管理] > [ユーザー] を選択します。対象の RAM ユーザー を見つけ、操作 列の [権限の追加] をクリックし、新しく作成した アクセスポリシー をユーザーに付与します。これにより、PolarDB はデータを動的に復号できるようになります。
-
ステップ 2:依存関係のインストール
Maven プロジェクトの pom.xml ファイルに次の依存関係を追加します。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-cls-jdbc</artifactId>
<version>1.0.10-1</version>
</dependency>
Maven の依存関係を追加する際は、ユースケースに応じて version の値を置き換えてください。Maven リポジトリで aliyun-cls-jdbc の最新バージョンを確認できます。
ステップ 3: MEK の設定
MEK は、JDBC プロパティ、ファイル設定、または URL 設定 を使用して設定できます。複数の設定方法を使用する場合、優先順位は次のとおりです: JDBC プロパティ 設定 > ファイル設定 > URL 設定。
-
以下の設定および接続方法では、
MEKはクライアントで処理され、エンベロープ暗号化を使用してサーバーに安全に送信されます。これにより、MEKが漏洩することはありません。 -
アプリケーションコードにアクセスキーペア(
AccessKey IDとAccessKey secret)をハードコーディングしないことをお勧めします。このトピックでは、環境変数を使用してアクセスキーペアを管理します。詳細については、「Linux、macOS、および Windows システムで環境変数を設定する」をご参照ください。 -
KMS が管理する MEK を取得するために 一時的な STS アクセス認証情報 を使用する必要がある場合は、STS SDK を使用して一時的な STS トークン を取得できます。STS SDK の例については、「STS SDK の概要」をご参照ください。
JDBC プロパティ
標準 JDBC 接続を確立する場合、Properties オブジェクトを使用してカスタム属性を設定できます。
例
// ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなどの接続情報を準備します。
String hostname = "your-hostname";
String port = "your-port";
String dbname = "your-database-name";
String username = "your-username";
String password = "your-password";
// 環境変数からアクセスキー ID とアクセスキーシークレットを取得します。
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 一時的な STS アクセス認証情報を使用して KMS キーを読み取る場合は、取得した STS トークンも提供する必要があります。
// String stsToken = "yourSecurityToken";
// KMS インスタンスエンドポイントには、インターネットアクセス用のパブリックエンドポイント、または VPC 内のアクセス用の VPC エンドポイントを使用します。
String kmsEndpoint = "your-kms-endpoint";
Properties props = new Properties();
props.setProperty("user", username);
props.setProperty("password", password);
props.setProperty("ALIBABA_CLOUD_ACCESS_KEY_ID", accessKeyId);
props.setProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET", accessKeySecret);
props.setProperty("ALIBABA_CLOUD_KMS_ENDPOINT", kmsEndpoint);
// props.setProperty("ALIBABA_CLOUD_STS_TOKEN","stsToken");
// MySQL データベースの接続 URL 形式は "jdbc:mysql:encdb://%s:%s/%s" です。
String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s", hostname, port, dbname);
// MySQL データベース用の EncJDBC ドライバーをロードします。
Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver");
// データベース接続を取得します。
Connection connection = DriverManager.getConnection(dbUrl, props);
// ... クエリを開始 ...
URL
接続 URL に KMS キー のパラメーターを埋め込むことができます。
例
// ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなどの接続情報を準備します。
String hostname = "your-hostname";
String port = "your-port";
String dbname = "your-database-name";
String username = "your-username";
String password = "your-password";
// 環境変数からアクセスキー ID とアクセスキーシークレットを取得します。
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 一時的な STS アクセス認証情報を使用して KMS キーを読み取る場合は、取得した STS トークンも提供する必要があります。
// String stsToken = "yourSecurityToken";
// KMS インスタンスエンドポイントには、インターネットアクセス用のパブリックエンドポイント、または VPC 内のアクセス用の VPC エンドポイントを使用します。
String kmsEndpoint = "your-kms-endpoint";
// 接続 URL に KMS キーのパラメーターを埋め込みます。
String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s?ALIBABA_CLOUD_ACCESS_KEY_ID=%s&ALIBABA_CLOUD_ACCESS_KEY_SECRET=%s&ALIBABA_CLOUD_KMS_ENDPOINT=%s", hostname, port, dbname, accessKeyId, accessKeySecret, kmsEndpoint);
// STS トークンを使用します。
// String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s?ALIBABA_CLOUD_ACCESS_KEY_ID=%s&ALIBABA_CLOUD_ACCESS_KEY_SECRET=%s&ALIBABA_CLOUD_KMS_ENDPOINT=%s&ALIBABA_CLOUD_STS_TOKEN=%s", hostname, port, dbname, accessKeyId, accessKeySecret, kmsEndpoint, stsToken);
// MySQL データベース用の EncJDBC ドライバーをロードします。
Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver");
// データベース接続を取得します。
Connection connection = DriverManager.getConnection(dbUrl, username, password);
// ... クエリを開始 ...
ステップ 4:プレーンテキストデータのクエリ
データベースに接続した後、標準の JDBC クエリと同様にデータベース操作を実行できます。EncJDBC は自動的に暗号化された列を復号し、プレーンテキストデータを返します。
例
// クエリステートメントを作成します。
Statement statement = connection.createStatement();
ResultSet resultSet = statement.executeQuery("SELECT * FROM your_table_name");
// 結果セットを反復処理します。
while (resultSet.next()) {
for (int i = 0; i < resultSet.getMetaData().getColumnCount(); i++) {
System.out.print(resultSet.getString(i + 1));
System.out.print("\t");
}
System.out.print("\n");
}
付録:コード例
この例では、Maven バージョン 3.9.9 と開発ツール IntelliJ IDEA Community Edition 2024.1.2 を使用します。
import java.sql.*;
import java.util.Properties;
public class EncryptedColumnAccess {
public static void main(String[] args) throws ClassNotFoundException, SQLException {
// 以下の接続情報を、ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなど、お使いのインスタンスの詳細に置き換えてください。
String hostname = "your-hostname";
String port = "your-port";
String dbname = "your-database-name";
String username = "your-username";
String password = "your-password";
// 環境変数からアクセスキー ID とアクセスキーシークレットを取得します。
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 一時的な STS アクセス認証情報を使用して KMS キーを読み取る場合は、取得した STS トークンも提供する必要があります。
// String stsToken = "yourSecurityToken";
// KMS インスタンスエンドポイントには、インターネットアクセス用のパブリックエンドポイント、または VPC 内のアクセス用の VPC エンドポイントを使用します。
String kmsEndpoint = "your-kms-endpoint";
Properties props = new Properties();
props.setProperty("user", username);
props.setProperty("password", password);
props.setProperty("ALIBABA_CLOUD_ACCESS_KEY_ID", accessKeyId);
props.setProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET", accessKeySecret);
props.setProperty("ALIBABA_CLOUD_KMS_ENDPOINT", kmsEndpoint);
// props.setProperty("ALIBABA_CLOUD_STS_TOKEN","stsToken");
// MySQL データベースの接続 URL 形式は "jdbc:mysql:encdb://%s:%s/%s" です。
String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s", hostname, port, dbname);
// EncJDBC ドライバーをロードします。
Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver");
// データベース接続を取得します。
Connection connection = DriverManager.getConnection(dbUrl, props);
// クエリを開始します。
try {
// クエリステートメントを作成します。
Statement statement = connection.createStatement();
ResultSet resultSet = statement.executeQuery("SELECT * FROM users");
// 結果セットを反復処理します。
while (resultSet.next()) {
int id = resultSet.getInt("id");
String name = resultSet.getString("username");
String phone = resultSet.getString("phone");
// テーブルスキーマに基づいて他のフィールドを処理します。
System.out.println("ID: " + id + ", Name: " + name + ", Phone: " + phone);
}
// リソースを閉じます。
resultSet.close();
statement.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
}
ローカルキーの利用
ステップ 1:MEK の生成
マスター暗号化キー (MEK) は、クライアントが暗号化されたデータにアクセスすることを許可するルート認証情報です。セキュリティのため、暗号化されたデータベースは MEK を保存、管理、生成、またはバックアップしません。その生成、安全な管理、およびバックアップは、お客様の単独の責任となります。MEK の保管と管理は、データベースのセキュリティにとって非常に重要です。MEK をバックアップすることを強く推奨します。
MEK:クライアントは、安全な非対称暗号化プロトコルを介して MEK をデータベースサーバーに送信します。これにより、クライアントとサーバーの両方が同じ キー を共有でき、対称暗号化による安全なデータ伝送が可能になります。
値の要件: 16 バイト (32 文字) の 16 進数文字列。例: 00112233445566778899aabbccddeeff。
一般的な生成方法:パスワード生成ツールやプログラミング言語のランダム関数を使用できます。
例
-
Linux では、組み込みの OpenSSL ツールを使用し、
openssl rand -hex 16を実行してキーを生成します。# OpenSSL を使用して安全なランダムキーを生成 openssl rand -hex 16 # 出力例:11ce9a9489fab7355cf710837cea5d5b -
Windows では、OpenSSL パッケージ をインストールします。
ステップ 2:依存関係のインストール
Maven プロジェクトの pom.xml ファイルに次の依存関係を追加します。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-cls-jdbc</artifactId>
<version>1.0.10-1</version>
</dependency>
Maven の依存関係を追加する際は、ユースケースに応じて version の値を置き換えてください。Maven リポジトリで aliyun-cls-jdbc の最新バージョンを確認できます。
ステップ 3: MEK の設定
MEK は、JDBC プロパティ、ファイル設定、または URL 設定を使用して設定できます。 複数の設定方法を使用する場合、優先順位は次のとおりです: JDBC プロパティ 設定 > ファイル設定 > URL 設定。
以下の設定および接続方法では、 MEK はクライアントで処理され、エンベロープ暗号化を使用してサーバーに安全に送信されます。これにより、 MEK が漏洩することはありません。
JDBC プロパティ
標準 JDBC 接続を確立する場合、Properties オブジェクトを使用してカスタム属性を設定できます。
例
// ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなどの接続情報を準備します。
String hostname = "your-hostname";
String port = "your-port";
String dbname = "your-database-name";
String username = "your-username";
String password = "your-password";
// マスター暗号化キー。
String mek = "00112233445566778899aabbccddeeff";
Properties props = new Properties();
props.setProperty("user", username);
props.setProperty("password", password);
props.setProperty("MEK", mek);
// MySQL データベースの接続 URL 形式は "jdbc:mysql:encdb://%s:%s/%s" です。
String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s", hostname, port, dbname);
// MySQL データベース用の EncJDBC ドライバーをロードします。
Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver");
// データベース接続を取得します。
Connection connection = DriverManager.getConnection(dbUrl, props);
// ... クエリを開始 ...
ファイル
ファイル設定方法は、ローカルキー の MEK を設定する場合にのみ適用されます。
設定ファイルからパラメーターをインポートして、必要な MEK を設定できます。プロジェクトで、encJdbcConfigFile プロパティを設定ファイルのパスに設定します。パスを指定しない場合、システムはデフォルトで encjdbc.conf ファイルを使用します。設定ファイルには、次の内容を含める必要があります。
MEK=00112233445566778899aabbccddeeff
例
-
設定ファイルの場所は、次の 2 つの方法のいずれかで指定できます:
-
以下の構造のように、プロジェクトの
resourcesディレクトリにファイルを配置します:src main java resources encjdbc.conf -
プロジェクトのルートディレクトリ (プログラムの実行時ディレクトリ) にファイルを配置します。
-
-
ファイルを設定した後、次のコードに示すように、プログラムで追加の設定を行う必要はありません:
// ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなどの接続情報を準備します。 String hostname = "your-hostname"; String port = "your-port"; String dbname = "your-database-name"; String username = "your-username"; String password = "your-password"; // MySQL データベースの接続 URL 形式は "jdbc:mysql:encdb://%s:%s/%s" です。 String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s", hostname, port, dbname); // MySQL データベース用の EncJDBC ドライバーをロードします。 Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver"); // データベース接続を取得します。 Connection connection = DriverManager.getConnection(dbUrl, username, password); // ... クエリを開始 ...
URL
接続 URL に MEK とその他のパラメーターを埋め込むことができます。
例
// ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなどの接続情報を準備します。
String hostname = "your-hostname";
String port = "your-port";
String dbname = "your-database-name";
String username = "your-username";
String password = "your-password";
// マスター暗号化キー。
String mek = "00112233445566778899aabbccddeeff";
// MySQL データベースの接続 URL 形式は "jdbc:mysql:encdb://%s:%s/%s?MEK=%s" です。
String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s?MEK=%s", hostname, port, dbname, mek);
// MySQL データベース用の EncJDBC ドライバーをロードします。
Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver");
// データベース接続を取得します。
Connection connection = DriverManager.getConnection(dbUrl, username, password);
// ... クエリを開始 ...
ステップ 4:プレーンテキストデータのクエリ
データベースに接続した後、標準の JDBC クエリと同様にデータベース操作を実行できます。EncJDBC は自動的に暗号化された列を復号し、プレーンテキストデータを返します。
例
// クエリステートメントを作成します。
Statement statement = connection.createStatement();
ResultSet resultSet = statement.executeQuery("SELECT * FROM your_table_name");
// 結果セットを反復処理します。
while (resultSet.next()) {
for (int i = 0; i < resultSet.getMetaData().getColumnCount(); i++) {
System.out.print(resultSet.getString(i + 1));
System.out.print("\t");
}
System.out.print("\n");
}
付録:コード例
この例では、Maven バージョン 3.9.9 と開発ツール IntelliJ IDEA Community Edition 2024.1.2 を使用します。
import java.sql.*;
import java.util.Properties;
public class EncryptedColumnAccess {
public static void main(String[] args) throws ClassNotFoundException, SQLException {
// 以下の接続情報を、ホスト名、ポート、データベース名 (dbname)、ユーザー名、パスワードなど、お使いのインスタンスの詳細に置き換えてください。
String hostname = "your-hostname";
String port = "your-port";
String dbname = "your-database-name";
String username = "your-username";
String password = "your-password";
String mek = "00112233445566778899aabbccddeeff";
Properties props = new Properties();
props.setProperty("user", username);
props.setProperty("password", password);
props.setProperty("MEK", mek);
// MySQL データベースの接続 URL 形式は "jdbc:mysql:encdb://%s:%s/%s" です。
String dbUrl = String.format("jdbc:mysql:encdb://%s:%s/%s", hostname, port, dbname);
// EncJDBC ドライバーをロードします。
Class.forName("com.aliyun.encdb.mysql.jdbc.EncDriver");
// データベース接続を取得します。
Connection connection = DriverManager.getConnection(dbUrl, props);
// クエリを開始します。
try {
// クエリステートメントを作成します。
Statement statement = connection.createStatement();
ResultSet resultSet = statement.executeQuery("SELECT * FROM users");
// 結果セットを反復処理します。
while (resultSet.next()) {
int id = resultSet.getInt("id");
String name = resultSet.getString("username");
String phone = resultSet.getString("phone");
// テーブルスキーマに基づいて他のフィールドを処理します。
System.out.println("ID: " + id + ", Name: " + name + ", Phone: " + phone);
}
// リソースを閉じます。
resultSet.close();
statement.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
}