公的個人認証サービス

利用者クライアントソフト API 仕様書【個人認証サービス AP Java インターフェース編】

第 4.3 版

地方公共団体情報システム機構

変更履歴
版数
1.0 版
1.1 版

2.0 版

2.1 版
2.2 版
2.3 版

2.4 版

2.5 版

変更日付
平成 16 年 1 月 16 日

変更内容
新規作成
Windows XP SP2 対応に伴い表 ３‑１のプラットフォーム
平成 16 年 10 月 14 日を追加
・ JavaDoc に JPKIConfirmResult クラスを追加
・ JavaDoc の JPKIUserCertService クラスに confirm
メソッドを追加
平成 18 年 5 月 2 日
・ 公的個人認証サービス利用者クライアントソフト
Ver2.0 のリリースに伴い、動作環境、ソフトウェア構成図を変更
平成 18 年 7 月 27 日 表 ３‑１動作環境 JavaVM に JRE5.0 Update7 を追加
・ MacOS 対応に伴い、第２章 ドキュメント体系、第平成 18 年 11 月 1 日
３章 動作環境、第４章 第１節 ソフトウェア構
成図 を変更平成 19 年 4 月 10 日 表 ３‑１動作環境を変更
・ 表 ３‑１動作環境
プラットフォームにWindowsVista, MacOS X 10.4.10, MacOS X 10.4.9を追加
・ 表 ３ ‑ １ 動 作 環 境 Web ブ ラ ウ ザ に Internet
平成 19 年 10 月 4 日
Explorer7.0 を追加
・ 表 ３‑１動作環境 JavaVM(Windows)に JRE6.0̲2,
JRE5.0̲12,JRE1.4.2̲13,JRE1.4.2̲15 を追加
・ 表 ３ ‑ １ 動 作 環 境 注 意 書 き ※ 6 に Mac OS X
10.4.10, 10.4.9 を追加
・ 表 ３‑１動作環境プラットフォームにWindowsVista
ServicePack1,WindowsXP
ServicePack3, MacOS X 10.5.4, MacOS X 10.5.3,
MacOS X 10.5.2, MacOS X 10.5.1, MacOS X 10.5,
MacOS X 10.4.11 を追加。
・ 表 ３ ‑ １ 動 作 環 境 Web ブ ラ ウ ザ に Internet
平成 20 年 10 月 10 日
Explorer6.0 ServicePack3 を追加。
・ 表 ３‑１動作環境 JavaVM(Windows)に JRE5.0̲15，JRE5.0̲13 ， JRE1.4.2̲17 ， JRE6.0̲7 ， JRE6.0̲6 ，JRE6.0̲5，JRE6.0̲4 を追加。
・ 表 ３‑１動作環境 Java for Mac OS X 10.5，Java for
Mac OS X 10.4 Release6 を追加。

版数2.6 版

2.7 版

3.0 版

3.1 版

4.0 版

4.0.1 版

変更日付変更内容
・ 図 ２ ‑ １ ド キ ュ メ ン ト 体 系 図 に 「 JavaDoc
JPKICryptJNI(64bit)」を追加。
・ 表 ３‑１動作環境を表 ３‑１ 動作環境(Windows)、
表 ３‑２ 動作環境(MacOS)、表 ３‑３ 動作環境(ICカード) に分割し、マトリクス形式の記述に変更。
・ 表 ３ ‑ １ 動 作 環 境 (Windows) の OS に Windows
平成 23 年 04 月 01 日
7(32/64 bit) ，WindowsVista ServicePack2 を追加、Web ブラウザに Internet Explorer8.0 を追加。
・ 表 ３‑２ 動作環境(MacOS)の OS に MacOS X 10.6.4，
MacOS X 10.5.6，MacOS X 10.5.5 を追加、Web ブラ
ウザに Safari 3.2, Safari 5.0 を追加。
・ 図 ４‑１ ソフトウェア構成図（Windows 対応版）を変更
・ 第３章 動作環境
表 ３‑１ 動作環境(Windows)
Windows2000 を 削 除 、 Windows8(32/64bit) 、Windows8.1(32/64bit)を追加
平成 25 年 12 月 01 日
表 ３‑２ 動作環境(MacOS)
MacOS X 10.4.X, 10.5.X, 10.6.X を削除、MacOS X
10.7.5, OS X 10.8.4 を追加
・ 第６章 画面仕様を追加。
・ 全体 「地方公共団体情報システム機構」への事業承継により、組織名称を変更する。
平成 26 年 04 月 01 日 ・ 全体 「公的個人認証サービス共通基盤事業運用会議」への事業承継により、「公的個人認証サービス都道府県協議会」の組織名称を変更する。
・ 第３章 動作環境
表 ３‑１ 動作環境(Windows)
Windows XP を削除、Windows7(32/64bit)の Web ブラ
ウ ザ を IE10.0 か ら IE11.0 に 変 更 、 Windows8(32/64bit)を削除、Windows 8.1 を Windows 8.1
update に変更
平成 26 年 07 月 01 日表 ３‑２ 動作環境(MacOS)
OS X 10.7.5 の Web ブラウザを Safari6.0 から Safari6.1 に変更、OS X 10.8.4 を OS X 10.8.5 に変更し、Web ブラウザを Safari6.0 から Safari6.1 に変更、
OS X 10.9.3(64bit)、Web ブラウザに Safari7.0 を追加
番号制度対応に伴い、以下を修正。
・第１章 第１節 用語の定義を追加。
・第２章 ドキュメント体系を修正。
平成 27 年 6 月 30 日 ・第３章 動作環境を修正。
・第４章 機能仕様を修正。
・第４章 第１節 ソフトウェア構成図(MacOS 対応版)を修正。
・第 3 章システム概要 動作環境 更新プログラムに係
平成 28 年 10 月 26 日
る注釈※3、4 の追加
その他、図の整形及び誤記等の文言修正

版数

4.1 版

4.2 版

4.3 版

変更日付

変更内容
PC 接続機能追加対応に伴い、以下を修正。
・第１章 第１節の「用語の定義」に以下を追加。
 PC/SC IC カードリーダライタ
 挿入
 NFC
 Bluetooth
・第２章 ドキュメント体系図に Android 版を追加。
平成 28 年 11 月 30 日
・第３章 表 3‑1 および表 3‑2 に PC 接続機能対応可否追加。
・第３章 表 3‑1 に Windows 10(32/64bit)を追加。
・第３章 表 3‑3 動作環境(共通)を表 3‑3 動作環境(ICカード)、
第 1 節 PC/SC 対応 IC カードリーダライタ、第 2 節 Android 端末に分割。
・第４章 第１節 ソフトウェア構成図に Bluetooth 通信を追加。
Java9 対応に伴い、以下を修正。
・第２章 ドキュメント体系図を改訂。
・第３章 表 ３‑１の OS から Windows Vista(32bit)を削除。
・第３章 表 ３‑１の OS から Windows 8(32bit)を削除。
・第３章 表 ３‑１の OS から Windows 8(64bit)を削除。
・第３章 表 ３‑１の JavaVM に JRE9 を追加。
・第３章 表 ３‑２の OS から OS X 10.8, 10.9 を削除。
平成 29 年 07 月 31 日
・第３章 表 ３‑２の OS に OS X 10.11, macOS v10.12を追加。
・第３章 表 ３‑２の JavaVM に JRE9 を追加。
・※２に説明文を追記。
・第３章 表 ３‑５の【PC 接続の場合】に Android 6.0.1、7.0 を追加。
・第３章 表 ３‑５の【Android 単体で利用する場合】にAndroid 6.0.1、7.0 を追加。
・第３章 表 ３‑２の OS から OS X 10.11 を削除。
・第３章 表 ３‑２の OS に macOS v10.13 を追加。
平成 31 年 03 月 31 日
・第３章 表 ３‑５の【PC 接続の場合】、【Android 単体で利用する場合】に Android 8.0 を追加。

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版−目次−

第１章 はじめに ......................................................... １
第１節 用語の定義 ............................................................................................................ ２

第２章 ドキュメント体系 ................................................. ３
第３章 動作環境 ......................................................... ５
第１節 PC/SC 対応 IC カードリーダライタ..................................................................... ７
第２節 Android 端末......................................................................................................... ８

第４章 機能仕様 ......................................................... ９
第１節 ソフトウェア構成図 .............................................................................................. ９
第２節 実現可能な機能の一覧 ...................................................................................... １１

第５章 API 仕様 ........................................................ １１
第６章 画面仕様 ....................................................... １１i

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第１章 はじめに
公的個人認証サービス 利用者クライアントソフト(以下、JPKI 利用者ソフト)における個人認証サービス AP は、以下の機能を実現するための Application Program Interface(以下、API)を提供する。
証明書表示機能

基本 4 情報取得機能



官職証明書検証機能



自分の電子証明書の有効性確認機能IC カード種別取得機能

以降、本書では個人認証サービス AP のうち、Java インターフェースの API 仕様について説明する。

１API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第１節

用語の定義
表 １‑１ 用語の定義

項番
用語・略号
1
IC カード2345678910説明
以下のカードを指す総称。
・住基カード・個人番号カード
電子証明書
公開鍵及び発行対象を識別する情報を含むデータに、認証局が発行対象の正当性を保証する電子署名を付与して、発行されるデータをいう。
データは、日本工業規格 X560‑1 の識別符号化規則により符号化された形式で利用される。
証明書
電子証明書と同義。
署 名用電 子証 公的個人認証サービスで発行した署名用途の利用者の電子証明書。
明書
本書では以下の電子証明書を指す。
・住基カードに格納された署名用電子証明書
・個人番号カードに格納された署名用電子証明書
利 用者証 明用 公的個人認証サービスで発行した利用者証明用途の利用者の電子証明電子証明書書。
本書では以下の電子証明書を指す。
・個人番号カードに格納された利用者証明用電子証明書
利用者証明書 公的個人認証サービスで発行した利用者の証明書。
本書では以下の電子証明書を指す。
・住基カードに格納された署名用電子証明書
・個人番号カードに格納された署名用電子証明書
・個人番号カードに格納された利用者証明用電子証明書
利用者秘密鍵 公開鍵暗号方式において用いられる鍵ペアの一方。公開鍵に対する、利用者のみが保有する鍵。
本書では以下の秘密鍵を指す。
・住基カードに格納された署名用利用者秘密鍵
・個人番号カードに格納された署名用利用者秘密鍵
・個人番号カードに格納された利用者証明用利用者秘密鍵認 証局の 自己 自認証局の公開鍵に対して、自認証局の秘密鍵で署名した証明書。
署名証明書
本書では以下の電子証明書を指す。
・住基カードに格納された都道府県知事の自己署名証明書
・個人番号カードに格納された署名用認証局の自己署名証明書
・個人番号カードに格納された利用者証明用認証局の自己署名証明書
PC/SC
Personal Computer/Smart Card の略。

12

IC カードリー 以下の機器を指す総称
ダライタ
・PC/SC 対応 IC カードリーダライタ
・Android 端末挿入
IC カードリーダライタが IC カードを読み込める状態にすること。
具体的には以下の状態にすることを指す。
・PC/SC 対応 IC カードリーダライタに IC カードをセットすること・Android 端末に IC カードをセットすること
NFC
Near Field Communication (近距離無線通信)の略。

13

Bluetooth11

機器間の近距離無線通信 IEEE 802.15.1 の規格名称。

２API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第２章 ドキュメント体系
JPKI 利用者ソフトのドキュメント体系図を以下に示す。本書は以下の体系図の網掛け部分に該当する。

利用者クライアントソフト 機能概要説明書
利用者クライアントソフトの機能概要について説明しています。

API 仕様書 カード AP ライブラリ CryptoAPI 編
カード AP ライブラリ(CryptoAPI)の API 仕様について説明しています。

API 仕様書 カード AP ライブラリ PKCS#11 編
カード AP ライブラリ(PKCS#11)の API 仕様について説明しています。

API 仕様書 カード AP ライブラリ Java インターフェース編
カード AP ライブラリ(Java インターフェース)の API 仕様について説明しています。

JavaDoc JPKICryptJNI
カード AP ライブラリ(Java インターフェース(住基カード署名用))の JavaDoc です。

JavaDoc JPKICryptJNI(64bit)
カード AP ライブラリ(Java インターフェース(住基カード署名用) 64bit)の JavaDoc です。

JavaDoc JPKICryptSignJNI
カード AP ライブラリ(Java インターフェース(個人番号カード署名用))の JavaDoc です。

JavaDoc JPKICryptSignJNI(64bit)
カード AP ライブラリ(Java インターフェース(個人番号カード署名用) 64bit)の JavaDoc です。

JavaDoc JPKICryptAuthJNI
カード AP ライブラリ(Java インターフェース(個人番号カード利用者証明用))の JavaDoc です。

JavaDoc JPKICryptAuthJNI(64bit)
カード AP ライブラリ(Java インターフェース(個人番号カード利用者証明用) 64bit)の JavaDoc です。

API 仕様書 個人認証サービス AP C 言語インターフェース編
個人認証サービス AP(C 言語インターフェース)の API 仕様について説明しています。

API 仕様書 個人認証サービス AP Java インターフェース編
個人認証サービス AP(Java インターフェース)の API 仕様について説明しています。

JavaDoc JPKIUserCertService
個人認証サービス AP(Java インターフェース)の JavaDoc です。

API 仕様書

Mac OS X C 言語インターフェース編

Mac OS X の C インターフェースの API 仕様について説明しています。

Jar ファイル利用手引き
利用者クライアントソフトの Jar ファイルを利用する方法について説明しています。

図 ２‑１ ドキュメント体系図３

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

利用者クライアントソフト 機能概要説明書(Android 版)
Android 版 JPKI 利用者ソフトの機能概要について説明しています。

API 仕様書 Android インテント編
インテントによる外部インターフェース仕様について説明しています。

図 ２‑２ ドキュメント体系図(Android 版)

４

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第３章 動作環境
個人認証サービス AP(Java インターフェース)の動作環境は以下の通りとする。
表 ３‑１ 動作環境(Windows)

OS(※1)
Windows 7(32bit)(Service Pack 1) (※3)
Windows 7(64bit)(Service Pack 1) (※3)
Windows 8.1 update (32bit) (※4)
Windows 8.1 update (64bit) (※4)
Windows 10(32bit 版)
Windows 10(64bit 版)

Web ブラウザ(※1, ※2)
IE11.0
IE11.0
IE11.0
IE11.0
IE11.0
IE11.0

JavaVM(※1,※6)

PC 接続機能
対応可否(※5)

JRE8.0JRE9.0○

×○○○○○○○○

×○
×○○○○○※1 本仕様書で定めるバージョンの開発時点の環境。最新の動作環境の情報は、JPKI ポータルサ
イトに掲載するものとする。
※2 プラットフォームが Windows の場合、暗号機能等の利用のために Internet Explorer が必要。
※3 Windows の更新プログラム(KB3033929)をインストールする必要がある。
(なお、更新プログラム(KB3033929)のインストール前に、関連する更新プログラム(KB3035131)が必要になる為、注意すること。)※4 Windows の更新プログラム(KB2919355)をインストールする必要がある。
※5 PC 接続機能については「利用者クライアントソフト 機能概要説明書 第３章 第３節 PC 接続機能について」を参照。
※6 JRE9.0 の 32bit 版は Oracle 社より提供されていないため非対応。

５

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

表 ３‑２ 動作環境(MacOS)
OS(※1, ※2)
macOS v10.12(64bit)
macOS v10.13(64bit)

JavaVM(※1)

Web
ブラウザ(※1)
Safari 10
Safari 11

JRE8.0JRE9.0○○○○PC 接続機能対応可否(※3)××※1 本仕様書で定めるバージョンの開発時点の環境。最新の動作環境の情報は、JPKI ポータルサ
イトに掲載するものとする。
※2 住基カードを使用する場合、または、住基カードと個人番号カードを両方使用する場合、動作前提条件として、Mac OS Forge が提供する「Smart Card Services」をそれぞれの OS に合ったものをダウンロードし、インストールする必要がある。
※3 PC 接続機能については「利用者クライアントソフト 機能概要説明書 第３章 第３節 PC 接続機能について」を参照。
IC カードの動作環境は以下の通りとする。

表 ３‑３ 動作環境(IC カード)項目
IC カード条件
住基カードまたは個人番号カードであること。
※PC 接続機能を使用する場合は個人番号カードのみ対応。

６

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第１節

PC/SC 対応 IC カードリーダライタ

PC/SC 対応 IC カードリーダライタの動作環境は以下の通りとする。

表 ３‑４ 動作環境(PC/SC 対応 IC カードリーダライタ)
項目

条件

PC/SC 対応 IC カード 以下の条件を満たす PC/SC 対応 IC カードリーダライタとする。(「個人リーダライタ
番号カード対応適合性検証済み IC カードリーダーライタ一覧」「住基カード対応適合性検証済み IC カードリーダーライタ一覧」(※1)を参照のこと。)
・ IC カードのインターフェース(非接触型、接触非接触両対応型)に対応していること。
・ PC/SC 対応 IC カードリーダライタであること。
・ USB など、パソコンに接続するためのインターフェースを有すること。
・ PC/SC 対応 IC カードリーダライタと通信するためのドライバソフトウェアが提供されていること。
・ IC カードの搬送方式が手動挿入/手動排出タイプまたは自動挿入/自動排出タイプであること。
・ IC カードを挿入するスロットの数は 1 つとし、1 度に挿入できる ICカードは 1 枚であること。
※1 最新の「個人番号カード対応適合性検証済み IC カードリーダーライタ一覧」「住基カード対応適合性検証済み IC カードリーダーライタ一覧」の情報は、JPKI ポータルサイトに掲載するものとする。

７

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第２節

Android 端末

Android 端末の動作環境は以下の通りとする。

表 ３‑５ 動作環境(Android 端末)
項目Android 端末条件
以下の条件を満たす Android 端末とする。
（「個人番号カード対応適合性検証済み Android 端末一覧」(※)を参照のこと。
）
・【PC 接続の場合】Android 4.3、5.1、6.0.1、7.0 または 8.0 搭載していること。
・【Android 単体で利用する場合】Android 5.1、6.0.1、7.0 または 8.0を搭載していること。
・Bluetooth 4.0 を搭載していること。
・ISO/IEC 14443 Type B に対応している NFC を搭載していること。

※ 最新の「個人番号カード対応適合性検証済み Android 端末一覧」の情報は、JPKI ポータルサイトに掲載するものとする。

８

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第４章 機能仕様
第１節 ソフトウェア構成図
本仕様書では、JPKI 利用者ソフトのうち、下図の太枠に示す個人認証サービス AP(Java インターフェース)の仕様をまとめる。
＜Windows 対応版＞
上位アプリケーション
CryptoAPI

PKCS#11 APIJavaI/F

JPKI 利用者ソフト

JavaI/F

C 言語 I/F

個人認証サービス AP
JavaI/F
個人認証サービス AP
C 言語 I/F
カード AP ライブラリ
Java I/F

カード AP ライブリ
PKCS#11

カード AP ライブラリ
CryptoAPI
カード AP ライブラリ
カード I/F
Windows Sockets API

SmartCardAPI※
SmartCardAPI※

Windows Sockets API

PC/SC リーダライタドライバ

Bluetooth ドライバ

カードコマンド
PC/SC リーダライタ

証明書
検証要求

オンライン窓口
処理要求

カードコマンド
Android 端末

カードコマンド

カードコマンド

公的個人認証サービスカードアプリケーション

官職証明書検証サービス※ Smart Card Resource Manager API の略

図 ４‑１ ソフトウェア構成図（Windows 対応版）

９

オンライン窓口サービス

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版＜MacOS 対応版＞
上位アプリケーション
PKCS#11 API

JavaI/F

JavaI/F

C 言語 I/F

JPKI 利用者ソフト
個人認証サービス AP
C 言語 I/F
個人認証サービス AP
JavaI/F
カード AP ライブラリ
カード AP ライブラリ
JavaI/F
PKCS#11
カード AP ライブラリ
カード I/F
Keychain Services API

CSSM API

Keychain Services

Smart Card
Services API（個人番号カードのみ対象の I/F）

証明書
検証要求

オンライン窓口
処理要求

CSSM (Common Security Services Manager)
Smart Card Services (PC/SC)
PC/SC リーダライタドライバ
カードコマンド
PC/SC リーダライタ
カードコマンド
公的個人認証サービスカードアプリケーション

官職証明書検証サービス

図 ４‑２ ソフトウェア構成図 (Mac OS 対応版)

１０

オンライン窓口
サービス

API 仕様書【個人認証サービス AP Java インターフェース編】第 4.3 版

第２節 実現可能な機能の一覧
個人認証サービス AP(Java インターフェース)で実現可能な機能の一覧を表 2に示す。
表 ４‑１ 実現可能な処理の一覧
NO機能1 証明書表示
2 基本 4 情報取得
3

官職証明書検証4

自分の電子証明書の有効性確認

5IC カード種別取得

概要
電子証明書を証明書 Viewer で表示する。
利用者証明書から基本 4 情報(氏名、住所、性別、生年月日)を取得する。
官職証明書や職責証明書の証明書検証を行うため、公的個人認証サービスの都道府県センターにある官職証明書検証サービスに対して証明書検証要求を発行する。
IC カード内の自分の電子証明書(利用者証明書)の有効性を確認するために、公的個人認証サービ
スの都道府県センターにあるオンライン窓口サービスに対して有効性確認要求を発行する。
IC カードリーダライタに挿入されている IC カードの種別を取得する。

第５章 API 仕様
個 人 認 証 サ ー ビ ス AP(Java イ ン タ ー フ ェ ー ス ) の API 仕 様 に つ い て は 、JavaDoc(JPKIUserCertService)を参照のこと。

第６章 画面仕様
個人認証サービス AP(Java インターフェース)の画面仕様については、個人認証サービス AP(C言語インターフェース)を参照のこと。

１１

禁・無断転載公的個人認証サービス
利用者クライアントソフト API 仕様書【個人認証サービス AP Java インターフェース編】
第 4.3 版

（注意事項）※利用者クライアントソフトの著作権は、総務省、地方公共団体情報システム機構が保有しており、国際著作権条約及び日本国の著作権関連法令によって保護されています。
※利用者クライアントソフトの利用に当たっては、次に掲げる行為を禁止します。
（1） 利用者クライアントソフトを電子署名に係る地方公共団体情報システム機構の認証業務に関する法律において制限されている電子証明書の用途で利用すること。
（2） 利用者クライアントソフトに対し、総務省、地方公共団体情報システム機構に許可なく改造等を行うこと。
※総務省、地方公共団体情報システム機構は、利用者が利用者クライアントソフトを利用したことにより発生した利用者の損害及び利用者が第三者に与えた損害について、一切の責任を負いません。
※商標については次の通りです。
（1） Microsoft Windows および Internet Explorer は、米国 Microsoft
Corporation の米国およびその他の国における登録商標または商標です。
（2） Macintosh、Mac、MacOS、OS X および Safari は、米国およびその他の国で登録されている Apple Inc.の登録商標です。
（3） Android は、Google Inc.の米国およびその他の国における登録商標です。
（4） その他、記載されている会社名、製品名等は、各社の登録商標または商標です。