このドキュメントでは、Gmail API で S/MIME メール証明書を使用する方法について説明します。
Gmail API を使用すると、Google Workspace ドメインのユーザーの S/MIME メール証明書をプログラムで管理できます。
証明書が機能するには、管理者がドメインのホスト型 S/MIME を有効にする必要があります。
S/MIME 標準は、公開鍵暗号化と MIME データの署名の仕様を提供します。ユーザー アカウントの S/MIME 証明書を構成すると、Gmail では次のように使用されます。
ユーザー証明書と秘密鍵を使用して送信メールに署名します。
ユーザーの秘密鍵を使用して受信メールを復号します。
受信者の証明書と公開鍵を使用して送信メールを暗号化します。
送信者の証明書と公開鍵を使用して受信メールを検証します。
個々の S/MIME 証明書を生成し、Gmail API を使用してアップロードできます。各 S/MIME 証明書は、ユーザーのメール アカウントの特定のエイリアス用です。エイリアスには、メインのメールアドレスとカスタムの送信専用アドレスが含まれます。API は、エイリアスごとに 1 つの S/MIME 証明書をデフォルトとしてマークします。
エイリアスの詳細については、Gmail API を使用してエイリアスと署名を管理するをご覧ください。
API アクセスを承認する
Gmail API へのアクセスを承認するには、次のいずれかの方法を使用します。
ドメイン全体の権限委任が設定されたサービス アカウントを使用します。これらの用語の説明については、認証と認可についてをご覧ください。このオプションを有効にするには、アクセス認証情報を作成するをご覧ください。
ユーザーの同意を必要とする標準の OAuth 2.0 フローを使用して、OAuth 2.0 アクセス トークンを取得します。詳細については、認証と認可についてをご覧ください。
このオプションを使用するには、ドメイン管理者が Google 管理コンソールで [メール送受信で S/MIME 暗号化を有効にする] チェックボックスをオンにする必要があります。詳しくは、管理コンソールでホスト型 S/MIME を有効にするをご覧ください。
認可スコープ
Gmail API は、Gmail sendAs メソッドと同じ OAuth スコープに依存しています。
gmail.settings.basic: プライマリSendAsS/MIME を更新するために必要です。gmail.settings.sharing: カスタムの from S/MIME を更新するために必要です。
S/MIME 鍵を構成する
settings.sendAs.smimeInfo リソースには、S/MIME 証明書を管理するためのメソッドがいくつか用意されています。各証明書は、ユーザーの 1 つの「差出人」エイリアスに関連付けられています。
ユーザーの送信専用エイリアスを特定するには、settings.sendAs リソースの settings.sendAs.list メソッドを使用します。
S/MIME 鍵をアップロードする
settings.sendAs.smimeInfo リソースの settings.sendAs.smimeInfo.insert メソッドを使用して、ユーザーに属するエイリアスの新しい S/MIME 鍵をアップロードします。次のパスパラメータを使用して、ターゲット エイリアスを特定します。
userId: ユーザーのメールアドレス。特別な値meを使用して、認証済みユーザーを示します。sendAsEmail: 鍵をアップロードするエイリアス。このメールアドレスは、このエイリアスを使用して送信されたメールのFrom:ヘッダーに表示されます。
S/MIME 証明書と秘密鍵を PKCS #12 形式で pkcs12 フィールドに入力します。リクエストで他のフィールドは設定しないでください。pkcs12 フィールドには、ユーザーの S/MIME 鍵と署名証明書チェーンの両方が含まれます。API は、このフィールドを受け入れる前に標準の検証を行い、次のことを確認します。
- 件名が指定されたメールアドレスと一致します。
- 有効期限は有効です。
- 発行元の認証局(CA)が Google の信頼できるリストに含まれている。
- 証明書が Gmail の技術的な制約を満たしている。
鍵が暗号化されている場合は、encryptedKeyPassword フィールドにパスワードを指定します。settings.sendAs.smimeInfo.insert メソッド呼び出しが成功すると、今後キーを参照するために使用される settings.sendAs.smimeInfo リソース id が返されます。
ユーザーの S/MIME 鍵のリストを取得する
settings.sendAs.smimeInfo リソースの settings.sendAs.smimeInfo.list メソッドを使用して、特定のエイリアスについて特定のユーザーの S/MIME 鍵のリストを返します。次のパス パラメータを使用して、ターゲット エイリアスを特定します。
userId: ユーザーのメールアドレス。特別な値meを使用して、認証済みユーザーを示します。sendAsEmail: キーを一覧表示するエイリアス。このメールアドレスは、このエイリアスを使用して送信されたメールのFrom:ヘッダーに表示されます。
エイリアスの S/MIME 鍵を取得する
settings.sendAs.smimeInfo リソースの settings.sendAs.smimeInfo.get メソッドを使用して、ユーザーの特定の送信専用エイリアスの特定の S/MIME 鍵を返します。次のパス パラメータを使用して、ターゲット エイリアスを特定します。
userId: ユーザーのメールアドレス。特別な値meを使用して、認証済みユーザーを示します。sendAsEmail: 鍵を取得するエイリアス。このメールアドレスは、このエイリアスを使用して送信されたメールのFrom:ヘッダーに表示されます。
S/MIME 鍵を削除する
settings.sendAs.smimeInfo リソースで settings.sendAs.smimeInfo.delete メソッドを使用して、エイリアスから指定された S/MIME 鍵を削除します。次のパスパラメータを使用して、ターゲット エイリアスを特定します。
userId: ユーザーのメールアドレス。特別な値meを使用して、認証済みユーザーを示します。sendAsEmail: 鍵を削除するエイリアス。このメールアドレスは、このエイリアスを使用して送信されたメールのFrom:ヘッダーに表示されます。id:smimeInfoの不変の ID。
削除された鍵は表示されなくなり、使用できなくなります。対応する公開鍵を使用して暗号化された受信 S/MIME メールを復号できません。鍵を削除する前に、発行元(CA)で鍵を取り消します。
エイリアスのデフォルトの S/MIME 鍵を設定する
settings.sendAs.smimeInfo リソースの settings.sendAs.smimeInfo.setDefault メソッドを使用して、指定された S/MIME キーを指定されたエイリアスのデフォルトとしてマークします。次のパス パラメータを使用して、ターゲット エイリアスを特定します。
userId: ユーザーのメールアドレス。特別な値meを使用して、認証済みユーザーを示します。sendAsEmail: デフォルトの鍵を設定するエイリアス。このメールアドレスは、このエイリアスを使用して送信されたメールのFrom:ヘッダーに表示されます。id:smimeInfoの不変の ID。
ユーザーの「差出人」エイリアスのデフォルトの S/MIME 鍵は 1 つだけです。settings.sendAs.smimeInfo.setDefault メソッドを呼び出すと、以前のデフォルト設定が解除されます。
ユーザーが特定の鍵で署名された S/MIME メッセージを受信すると、Gmail は、関連付けられたユーザーに送信されるメールを暗号化する際のデフォルトとして、最も未来の not_before 有効期限を持つ鍵を関連付けます。ユーザーがすでに通信している Gmail ユーザーが新しいデフォルト鍵を使用するようにするには、新しいデフォルト鍵の not_before 日付が以前のデフォルト鍵よりも後になるようにするか、以前のデフォルト鍵を取り消します。
コードサンプル
次のコードサンプルは、Gmail API を使用して複数のユーザーがいる組織の S/MIME 証明書を管理する方法を示しています。
S/MIME 証明書の smimeInfo リソースを作成する
次のコードサンプルは、ファイルから証明書を読み取り、Base64URL 文字列にエンコードして、settings.sendAs.smimeInfo リソースの pkcs12 フィールドに割り当てる方法を示しています。
Java
Python
S/MIME 証明書をアップロードする
証明書をアップロードするには、settings.sendAs.smimeInfo.insert メソッドを呼び出し、リクエストの本文で settings.sendAs.smimeInfo リソースを指定します。
Java
Python
複数のユーザーの証明書を管理する
次のコードサンプルは、組織内の複数のユーザーの証明書を 1 つのバッチ呼び出しで管理する方法を示しています。
CSV ファイルから証明書を挿入する
次に、ユーザー ID と各ユーザーの証明書のパスを一覧表示する CSV ファイルの例を示します。
$ cat certificates.csv
user1@example.com,/path/to/user1_cert.p12,cert_password_1
user2@example.com,/path/to/user2_cert.p12,cert_password_2
user3@example.com,/path/to/user3_cert.p12,cert_password_3
Java
CreateSmimeInfo と InsertSmimeInfo のサンプルを使用して、CSV ファイルで指定されたユーザーの証明書をアップロードできます。
Python
create_smime_info と insert_smime_info のサンプルを使用して、CSV ファイルで指定されたユーザーの証明書をアップロードできます。
証明書の管理
このサンプルでは、settings.sendAs.smimeInfo リソースの複数のメソッドを組み合わせて、組織の証明書を管理する方法を示します。ユーザーの証明書が一覧表示されます。デフォルトの証明書が期限切れであるか、設定されていない場合は、指定されたファイルにある証明書がアップロードされます。次に、有効期限が最も先の証明書をデフォルトとして設定します。
この関数は、前の CSV ファイルから証明書を挿入するサンプルと同様に、CSV ファイルを処理します。