Classes

The following classes are available globally.

  • See more

    Declaration

    Swift

    @objcMembers
public class BuildConfig

  • CardFilesは、AP内の全てのデータを格納するクラスです。

    See more

    Declaration

    Swift

    public class CardFiles : NSObject

  • DriverLicenseAPは免許証APを操作するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class DriverLicenseAP : NSObject
  • See more

    Declaration

    Swift

    public class EPKey : NSObject

  • EPMRZは、パスポートのMachine Readable Zone (MRZ)に記載された情報に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPMRZ : NSObject

  • INDriverLicenseAPはマイナ運転免許証APを操作するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INDriverLicenseAP : NSObject

  • INTextAPは券面入力補助APを操作するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INTextAP : NSObject

  • INVisualAPは券面APを操作するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INVisualAP : NSObject
  • See more

    Declaration

    Swift

    @objc
public class CoreNFCDriver : NSObject, NFCDriver

  • JeidReaderは、各種APのインスタンスを取得するために使用するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class JeidReader : NSObject

  • PassportAPはパスポートAPを操作するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class PassportAP : NSObject

  • RCKeyは在留カード等番号に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCKey : NSObject

  • ResidenceCard2APは第2世代在留カード/第2世代特別永住者証明書APを操作するクラスです。
    第1世代(ResidenceCardAP)との主な違いは SM 方式で、相互認証(MUTUAL AUTHENTICATE)による AES-128-CBC + AES-CMAC を用います(RC2SecureMessaging)。 (Android 版 ResidenceCard2AP と同じ実装)

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class ResidenceCard2AP : NSObject

  • ResidenceCardAPは在留カードAPを操作するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class ResidenceCardAP : NSObject

  • SpecifiedResidenceCardAPは特定在留カード等(特定在留カード・特定特別永住者証明書)APを 操作するクラスです。
    特定在留カード等は個人番号カード上の在留APとして実装されるため、起動直後は 在留APがカレントではありません(JeidReader.selectRCS()が在留APを選択します)。
    データ構造(EF構成・タグ体系・署名アルゴリズム)は第2世代在留カード等 (ResidenceCard2AP)と共通で、RC2Files系のデータクラスをそのまま使います。 異なるのはSM方式だけで、SET SESSION KEYによるRSA-OAEP鍵配送とcounterベースのIVを 用います(RCSSecureMessaging)。 (Android 版 SpecifiedResidenceCardAP と同じ実装)

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class SpecifiedResidenceCardAP : NSObject

  • ValidationParametersは、署名検証の動作を調整するパラメータを表すクラスです。

    See more

    Declaration

    Swift

    public class ValidationParameters : NSObject

  • ValidationResultは、署名検証結果を表すクラスです。

    See more

    Declaration

    Swift

    public class ValidationResult : NSObject

  • DLCategoryは、運転免許証仕様の「免許の年月日」に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLCategory : NSObject

  • DLChangedEntriesは、運転免許証仕様の「記載事項変更等(本籍除く)」および「記載事項変更(本籍)」に対応するクラスです。 DriverLicenseAP#readChangedEntries() および DriverLicenseAP#readChangedRegisteredDomicile() を使用して取得します。

    See more

    Declaration

    Swift

    public class DLChangedEntries : NSObject

  • DLChangedEntryは、運転免許証仕様の「記載事項変更等(本籍除く)」および「記載事項変更(本籍)」に記載される1つの項目に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLChangedEntry : NSObject

  • DLCommonDataは、運転免許証仕様の「共通データ要素」に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLCommonData : NSObject

  • DLDateは、元号+YYMMDD形式の日付クラスです。

    See more

    Declaration

    Swift

    public class DLDate : NSObject

  • DLEntriesは、運転免許証仕様の「記載事項(本籍除く)」に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLEntries : NSObject

  • DLExternalCharactersは、運転免許証仕様の「外字」および「記載事項変更(外字)」に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLExternalCharacters : NSObject

  • DLFilesは、運転免許証APの全てのデータを格納するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class DLFiles : CardFiles

  • DLPhotoは、運転免許証仕様の「写真」に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLPhoto : NSObject

  • DLPinSettingは、運転免許証仕様の「暗証番号(PIN)設定」に対応するクラスです。
    極めて稀に、暗証番号が設定されていない免許証があります。
    暗証番号が設定されていない免許証はデフォルトの暗証番号「****」を入力して読み出します。
    isPinSetプロパティで暗証番号が設定されているかどうかを確認できます。

    See more

    Declaration

    Swift

    public class DLPinSetting : NSObject

  • DLRegisteredDomicileは、運転免許証仕様の「記載事項(本籍)」に対応するクラスです。

    See more

    Declaration

    Swift

    public class DLRegisteredDomicile : NSObject

  • DLSignatureは、運転免許証仕様の「電子署名」に対応するクラスです。

    Remark

    このオブジェクトは署名を検証することができます。署名の検証に使用する場合、3つの段階があります。
    1. 初期化

      このオブジェクトを初期化します。initVerifyメソッドを参照してください。

    2. 更新

      検証の対象となるデータを更新します。updateメソッドを参照してください。

    3. 署名の検証

      すべての更新済みデータに対して署名の検証を行います。verifyメソッドを参照してください。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class DLSignature : NSObject

  • DLStringは、運転免許証で利用される外字を含む文字列クラスです。
    toString()を使用してこのオブジェクトを文字列として表現できます。 1つめの外字は【※１】、7つめの外字は【※７】、欠字は【※欠】と表現されます。
    toJSON()やtoHTML()を使用して外字を含む文字列を様々なフォーマットで表現できます。 詳細は運転免許証の文字についてをご参照ください。

    See more

    Declaration

    Swift

    public class DLString : NSObject

  • INDLCategoryは、マイナ運転免許証の「免許の年月日」と「免許の種類」に対応するクラスです。

    See more

    Declaration

    Swift

    public class INDLCategory : NSObject

  • INDLEntriesは、マイナ運転免許証の「免許情報記録」に対応するクラスです。

    See more

    Declaration

    Swift

    public class INDLEntries : NSObject

  • INDLFilesは、マイナ運転免許証APの全てのデータを格納するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INDLFiles : CardFiles

  • INDLPhotoは、マイナ運転免許証仕様の「写真」に対応するクラスです。

    See more

    Declaration

    Swift

    public class INDLPhoto : NSObject

  • INDLSignatureは、マイナ運転免許証仕様の「電子署名」に対応するクラスです。

    See more

    Declaration

    Swift

    public class INDLSignature : NSObject

  • EPCommonDataは、パスポートのCommonDataに対応するクラスです。

    See more

    Declaration

    Swift

    public class EPCommonData : EPDataGroup

  • EPDataGroupは、パスポートのDataGroupに対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup : NSObject

  • EPDataGroup1は、パスポートのDG1に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup1 : EPDataGroup

  • EPDataGroup10は、パスポートのDG10に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup10 : EPDataGroup

  • EPDataGroup11は、パスポートのDG11に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup11 : EPDataGroup

  • EPDataGroup12は、パスポートのDG12に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup12 : EPDataGroup

  • EPDataGroup13は、パスポートのDG13に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup13 : EPDataGroup

  • EPDataGroup14は、パスポートのDG14に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup14 : EPDataGroup

  • EPDataGroup15は、パスポートのDG15に対応するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class EPDataGroup15 : EPDataGroup

  • EPDataGroup2は、パスポートのDG2に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup2 : EPDataGroup

  • EPDataGroup3は、パスポートのDG3に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup3 : EPDataGroup

  • EPDataGroup4は、パスポートのDG4に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup4 : EPDataGroup

  • EPDataGroup5は、パスポートのDG5に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup5 : EPDataGroup

  • EPDataGroup6は、パスポートのDG6に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup6 : EPDataGroup

  • EPDataGroup7は、パスポートのDG7に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup7 : EPDataGroup

  • EPDataGroup8は、パスポートのDG8に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup8 : EPDataGroup

  • EPDataGroup9は、パスポートのDG9に対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDataGroup9 : EPDataGroup

  • EPDocumentSecurityObjectは、パスポートのSODに対応するクラスです。

    See more

    Declaration

    Swift

    public class EPDocumentSecurityObject : EPDataGroup

  • EPFilesは、パスポートAPの全てのデータを格納するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class EPFiles : CardFiles
  • See more

    Declaration

    Swift

    public class EPSecurityObject : NSObject

  • INTextAttributesは、個人番号カードの券面入力補助APの4情報(氏名・住所・生年月日・性別)に対応するクラスです。

    See more

    Declaration

    Swift

    public class INTextAttributes : NSObject

  • INTextFilesは、個人番号カードの券面入力補助AP内のデータを格納するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INTextFiles : CardFiles

  • INTextMyNumberは、個人番号カードの券面入力補助APの個人番号(文字列)に対応するクラスです。

    See more

    Declaration

    Swift

    public class INTextMyNumber : NSObject

  • INVisualEntriesは、個人番号カードの券面APの表面に対応するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INVisualEntries : NSObject

  • INVisualFilesは、個人番号カードの券面AP内のデータを格納するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INVisualFiles : CardFiles

  • INVisualMyNumberは、個人番号カードの券面APの個人番号(画像)に対応するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class INVisualMyNumber : NSObject

  • RCAddressは、在留カードおよび特別永住者証明書の住居地（裏面追記）に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCAddress : NSObject

  • RCCardEntriesは、在留カードおよび特別永住者証明書の券面（表）イメージ(DF1/EF01)に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCCardEntries : NSObject

  • RCCardTypeは、在留カードおよび特別永住者証明書のカード種別に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCCardType : NSObject

  • RCCommonDataは、在留カードおよび特別永住者証明書の共通データ要素に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCCommonData : NSObject

  • RCComprehensivePermissionは、在留カードの裏面資格外活動包括許可欄(DF2/EF02)に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCComprehensivePermission : NSObject

  • RCFilesは、在留カードAPの全てのデータを格納するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class RCFiles : CardFiles

  • RCIndividualPermissionは、在留カードの裏面資格外活動個別許可欄(DF2/EF03)に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCIndividualPermission : NSObject

  • RCPhotoは、在留カードおよび特別永住者証明書の顔画像(DF1/EF02)に対応するクラスです。

    See more

    Declaration

    Swift

    public class RCPhoto : NSObject

  • RCSignatureは、在留カードおよび特別永住者証明書のチェックコード・公開鍵証明書(DF3/EF01)に対応するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 12.0, *)
public class RCSignature : NSObject

  • RCUpdateStatusは、在留カードの裏面在留期間等更新申請欄(DF2/EF04)に対応するクラスです。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class RCUpdateStatus : NSObject

  • RC2AddressImageは、第2世代在留カード等の住居地イメージ(DF1/EF04)に対応するクラスです。
    タグ “DFD1” (多バイトタグ; RC2BERParser は2バイト目 0xD1 をタグとして返す)、 MMR(CCITT T.6)圧縮 TIFF。

    See more

    Declaration

    Swift

    public class RC2AddressImage : NSObject

  • RC2CardEntriesは、第2世代在留カード等の券面記載事項(DF1/EF02)に対応するクラスです。
    タグ C5〜CE(RC2BERParser のマスク値 0x05〜0x0E)。在留カードは10項目、 特別永住者証明書では CA/CB/CC/CD (在留カードのみの項目)が存在しません。

    See more

    Declaration

    Swift

    public class RC2CardEntries : NSObject

  • RC2CardNumberは、第2世代在留カード等に記録された在留カード等番号(DF1/EF01)に 対応するクラスです。 タグ “C2"、12byteテキスト。

    See more

    Declaration

    Swift

    public class RC2CardNumber : NSObject

  • RC2CardTypeは、第2世代在留カード等のカード種別(MF/EF02)に対応するクラスです。 タグ “C1"、2byte値("05”:第2世代在留カード / “06”:第2世代特別永住者証明書 / “07”:特定在留カード / “08”:特定特別永住者証明書)。

    カード種別要素の構造は第1世代(RCCardType)と共通のためこれを継承します。

    Declaration

    Swift

    public class RC2CardType : RCCardType

  • RC2Codeは、第2世代在留カード等の券面記載事項に含まれるコードを 券面表示(日本語)へ変換するテーブルです。
    出典: 出入国在留管理庁「第二世代・特定在留カード等のコード表データ」。 libjeid-common/rc2code/gen.py が csv/*.csv から生成しました。手で編集しないこと。
    券面表示はコードに対して一意ですが、逆は成り立ちません (例: 中国/香港/マカオ, 英国とその海外領土, 39種の無国籍区分は表示がまとまる)。 識別には常に生のコードを使ってください。

    See more

    Declaration

    Swift

    public class RC2Code : NSObject

  • RC2CommonDataは、第2世代在留カードおよび第2世代特別永住者証明書の共通データ要素(MF/EF01)に 対応するクラスです。タグ “C0"。

    See more

    Declaration

    Swift

    public class RC2CommonData : NSObject

  • RC2FaceImageは、第2世代在留カード等の顔画像(DF1/EF03のD1)に対応するクラスです。
    タグ “D1” (RC2BERParser のマスク値 0x11)、JPEG2000、最大3000byte。
    1歳未満の中長期在留者・特別永住者では顔画像が length=0 で書き込まれます。
    DF1/EF03には氏名イメージ(D0)と顔画像(D1)が格納されており、 氏名イメージは RC2NameImage が同じEFから読み出します。

    See more

    Declaration

    Swift

    public class RC2FaceImage : NSObject

  • RC2Filesは、第2世代在留カード/第2世代特別永住者証明書APの全てのデータを格納するクラスです。
    特定在留カード等(特定在留カード・特定特別永住者証明書)はデータ構造が共通のため、 SpecifiedResidenceCardAP.readFiles()もこのクラスを返します。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class RC2Files : CardFiles

  • RC2NameImageは、第2世代在留カード等の氏名イメージ(DF1/EF03のD0)に対応するクラスです。
    タグ “D0” (RC2BERParser のマスク値 0x10)、MMR(CCITT T.6)圧縮 TIFF、最大2500byte。
    DF1/EF03には氏名イメージ(D0)と顔画像(D1)が格納されており、 顔画像は RC2FaceImage が同じEFから読み出します。

    See more

    Declaration

    Swift

    public class RC2NameImage : NSObject

  • RC2Othersは、第2世代在留カード等のその他(DF2/EF03)に対応するクラスです。
    D9(0x19): 出入国在留管理庁長官記載 (0/1)、DE(0x1E): 予備 (最大100文字, JIS X0213:2004)。

    See more

    Declaration

    Swift

    public class RC2Others : NSObject

  • RC2Permissionは、第2世代在留カード等の資格外活動許可欄(DF2/EF01)に対応するクラスです。
    在留カード(第2世代在留カード・特定在留カード)のみに存在し、 特別永住者証明書にはありません。
    D5(0x15): 包括許可欄、D6(0x16): 包括許可期限、D7(0x17): 個別許可欄。

    See more

    Declaration

    Swift

    public class RC2Permission : NSObject

  • RC2Signatureは、第2世代在留カード等の電子署名(DF3/EF01)に対応するクラスです。
    DC(マスク値0x1C): チェックコード(ECDSA P-384 署名値 r‖s, 96byte)、 DD(マスク値0x1D): 公開鍵証明書(X.509 v3, ECDSA NIST P-384, SHA-256)。

    See more

    Declaration

    Swift

    @available(iOS 13.0, *)
public class RC2Signature : NSObject

  • RC2UpdateStatusは、第2世代在留カード等の在留期間更新等許可申請ステータス(DF2/EF02)に 対応するクラスです。タグ D8(0x18): 0(無し) / 1(申請中)。
    在留カード(第2世代在留カード・特定在留カード)のみに存在し、 特別永住者証明書にはありません。

    See more

    Declaration

    Swift

    public class RC2UpdateStatus : NSObject