All Classes and Interfaces
Class
Description
Java callback interface
This interface must be implemented at the application side by a class that should receive
the callback(s).
Class representing an ICAO-compliant card (MRTD - Machine Readable Travel Document).
Provides access to standardized Data Groups (DGs) such as identity information,
biometric data, and additional holder information, as well as authentication
mechanisms like BAC (Basic Access Control) and PACE (Password Authenticated Connection Establishment).
Reading Data groups requires prior authentication with either PACE or BAC.
Provides access to standardized Data Groups (DGs) such as identity information,
biometric data, and additional holder information, as well as authentication
mechanisms like BAC (Basic Access Control) and PACE (Password Authenticated Connection Establishment).
Reading Data groups requires prior authentication with either PACE or BAC.
Class for the Address information associated to an EID Card.
You can get such an object from PTEID_EIDCard::getAddr().
You can get such an object from PTEID_EIDCard::getAddr().
Helper class to deal with ASIC signature containers used by pteid-mw to deliver XAdES signatures
"attached to their input files"
"attached to their input files"
Class used to receive and supply an array of bytes from/to different methods in the SDK.
Memory management note - instances of this class will not own the char arrays that are supplied to
it in the constructor or Append() methods as this class will perform copies of the input arrays
Memory management note - instances of this class will not own the char arrays that are supplied to
it in the constructor or Append() methods as this class will perform copies of the input arrays
Abstract base class for all the card types supported.
PTEID_ReaderContext::getCard() method
will return such an object.
PTEID_ReaderContext::getCard() method
will return such an object.
Class for the info document.
You can get such an object from PTEID_EIDCard::getVersionInfo().
You can get such an object from PTEID_EIDCard::getVersionInfo().
Class that represents one certificate.
Container class for all certificates on the card.
This class is a client for signing with Chave Móvel Digital.
Class to access and modify the config parameters of pteid-mw.
These parameters are persisted in the Windows Registry under the HKEY_CURRENT_USER\Software\PTEID key
or in the pteid.conf file of the current user (on Linux and MacOS systems)
These parameters are persisted in the Windows Registry under the HKEY_CURRENT_USER\Software\PTEID key
or in the pteid.conf file of the current user (on Linux and MacOS systems)
Class for the ID document on a EID Card.
You can get such an object from PTEID_EIDCard::getID().
You can get such an object from PTEID_EIDCard::getID().
This class represents a Portugal EID card.
To get such an object you have to ask it from the ReaderContext.
To get such an object you have to ask it from the ReaderContext.
Exception class Bad Transaction (error code = EIDMW_ERR_BAD_TRANSACTION)
Throw when a class/function is not used correctly
Used in : - PTEID_ReaderContext::Lock()
- PTEID_ReaderContext::Unlock()
Throw when a class/function is not used correctly
Used in : - PTEID_ReaderContext::Lock()
- PTEID_ReaderContext::Unlock()
Exception class Bad Usage (error code = EIDMW_ERR_BAD_USAGE)
Throw when a class/function is not used correctly
Used in : - PTEID_Crl class
Throw when a class/function is not used correctly
Used in : - PTEID_Crl class
Exception class PTEID_ExBatchSignatureFailed error codes:
All error codes related with pdf signatures (except timestamp/LTV errors), e.g.:
EIDMW_PDF_INVALID_ERROR
EIDMW_PDF_UNSUPPORTED_ERROR
EIDMW_PDF_INVALID_PAGE_ERROR
Throw when batch signature fails.
Used in : - int PTEID_EIDCard::SignPDF(PTEID_PDFSignature &sig_handler, int page, double coord_x, double coord_y, const char *location, const char *reason, const char *outfile_path)
Use GetFailedSignatureIndex() to know which of the signatures(from the batch) failed.
All error codes related with pdf signatures (except timestamp/LTV errors), e.g.:
EIDMW_PDF_INVALID_ERROR
EIDMW_PDF_UNSUPPORTED_ERROR
EIDMW_PDF_INVALID_PAGE_ERROR
Throw when batch signature fails.
Used in : - int PTEID_EIDCard::SignPDF(PTEID_PDFSignature &sig_handler, int page, double coord_x, double coord_y, const char *location, const char *reason, const char *outfile_path)
Use GetFailedSignatureIndex() to know which of the signatures(from the batch) failed.
Exception class Card Type Unknown (error code = EIDMW_ERR_CARDTYPE_UNKNOWN)
Throw when the card type is not supported
Used in : - PTEID_ReaderContext::getCard()
Throw when the card type is not supported
Used in : - PTEID_ReaderContext::getCard()
Base class for the PTEID SDK Exceptions
Exception class Certificate No OCSP responder (error code = EIDMW_ERR_CERT_NOROOT)
Throw when ask for the Root
Used in : - PTEID_Certificate::getRoot()
Throw when ask for the Root
Used in : - PTEID_Certificate::getRoot()
Exception class Command Not Allowed (error code = EIDMW_ERR_CMD_NOT_ALLOWED)
Throw when the command asked is not allowed
Used in : - PTEID_SmartCard::writeFile(const char *fileID,const PTEID_ByteArray &out,PTEID_Pin *pin,const char *csPinCode)
Throw when the command asked is not allowed
Used in : - PTEID_SmartCard::writeFile(const char *fileID,const PTEID_ByteArray &out,PTEID_Pin *pin,const char *csPinCode)
Exception class Command Not Supported (error code = EIDMW_ERR_NOT_SUPPORTED)
Throw when the command asked is not supported by the card
Throw when the command asked is not supported by the card
Exception class File Type Unknown (error code = EIDMW_ERR_FILETYPE_UNKNOWN)
Throw when the Raw Data type doesn't exist for this card
Used in : - PTEID_Card::getRawData(PTEID_RawDataType type)
Throw when the Raw Data type doesn't exist for this card
Used in : - PTEID_Card::getRawData(PTEID_RawDataType type)
Exception class No Card Present (error code = EIDMW_ERR_NO_CARD)
Throw when no card is present
Used in : - PTEID_ReaderContext::getCardType()
- PTEID_ReaderContext::getCard()
- PTEID_ReaderContext::getEIDCard()
Throw when no card is present
Used in : - PTEID_ReaderContext::getCardType()
- PTEID_ReaderContext::getCard()
- PTEID_ReaderContext::getEIDCard()
Exception class No reader (error code = EIDMW_ERR_NO_READER)
Throw when the reader set is empty
Used in : - PTEID_Object::checkContextStillOk()
Throw when the reader set is empty
Used in : - PTEID_Object::checkContextStillOk()
Exception class Bad Parameter Range (error code = EIDMW_ERR_PARAM_RANGE)
Throw when the element ask is out of range
Used in : - PTEID_ReaderSet::getReaderName(unsigned long ulIndex)
- PTEID_ReaderSet::getReaderByNum(unsigned long ulIndex)
- PTEID_Certificate::getChildren(unsigned long ulIndex)
- PTEID_Certificates::getCertByNumber(unsigned long ulIndex)
- PTEID_Pins::getPinByNumber(unsigned long ulIndex)
Throw when the element ask is out of range
Used in : - PTEID_ReaderSet::getReaderName(unsigned long ulIndex)
- PTEID_ReaderSet::getReaderByNum(unsigned long ulIndex)
- PTEID_Certificate::getChildren(unsigned long ulIndex)
- PTEID_Certificates::getCertByNumber(unsigned long ulIndex)
- PTEID_Pins::getPinByNumber(unsigned long ulIndex)
Exception class Release Needed (error code = EIDMW_ERR_RELEASE_NEEDED)
Throw when the application close without calling PTEID_ReleaseSDK
Throw when the application close without calling PTEID_ReleaseSDK
Exception class SOD error error codes:
EIDMW_SOD_UNEXPECTED_VALUE
EIDMW_SOD_UNEXPECTED_ASN1_TAG
EIDMW_SOD_UNEXPECTED_ALGO_OID
EIDMW_SOD_ERR_HASH_NO_MATCH_ID
EIDMW_SOD_ERR_HASH_NO_MATCH_ADDRESS
EIDMW_SOD_ERR_HASH_NO_MATCH_PICTURE
EIDMW_SOD_ERR_HASH_NO_MATCH_PUBLIC_KEY
Throw when the SOD is not correct
EIDMW_SOD_UNEXPECTED_VALUE
EIDMW_SOD_UNEXPECTED_ASN1_TAG
EIDMW_SOD_UNEXPECTED_ALGO_OID
EIDMW_SOD_ERR_HASH_NO_MATCH_ID
EIDMW_SOD_ERR_HASH_NO_MATCH_ADDRESS
EIDMW_SOD_ERR_HASH_NO_MATCH_PICTURE
EIDMW_SOD_ERR_HASH_NO_MATCH_PUBLIC_KEY
Throw when the SOD is not correct
Exception class Release Needed (error code = EIDMW_ERR_UNKNOWN)
Base class for the object of PTEID SDK (Can not be instantiated).
Enumeration that includes all the configuration values of pteid-mw
They are grouped in different sections: general, logging, certcache, proxy, guitool, xsign
They are grouped in different sections: general, logging, certcache, proxy, guitool, xsign
Helper class for the PTEID_EIDCard::SignPDF() methods - it defines multiple options that affect the signature
operation e.g Signature in batch mode, adding a cryptographic timestamp, small format visible signature and custom
image in the visible signature
operation e.g Signature in batch mode, adding a cryptographic timestamp, small format visible signature and custom
image in the visible signature
Class that represents the Citizen photograph stored in a pteid card
Class that represent one card PIN.
Container class for all pins on the card.
Class that represents the card authentication public key - to be used in a mutual authentication process (1024 bit
RSA key) This key is totally unrelated to the citizen authentication key which is present in the authentication
certificate
RSA key) This key is totally unrelated to the citizen authentication key which is present in the authentication
certificate
This class represent a reader.
You get a reader object from the ReaderSet
either by its index (getReaderByNum) or by its name (getReaderByName).
Once you have a reader object, you can check if a card is present (isCardPresent).
Then you can ask which type of card is in the reader with getCardType()
and then get a card object using one of this methods :
getCard or getEIDCard.
You get a reader object from the ReaderSet
either by its index (getReaderByNum) or by its name (getReaderByName).
Once you have a reader object, you can check if a card is present (isCardPresent).
Then you can ask which type of card is in the reader with getCardType()
and then get a card object using one of this methods :
getCard or getEIDCard.
This is a singleton class that is the starting point to get all other objects.
You get an instance from the static instance() method (or using the define ReaderSet).
Then you get a READER (PTEID_ReaderContext)
-> from this reader, you a CARD (PTEID_Card or derived class)
-> from this card, you get identity or address objects (PTEID_EId or PTEID_Address)
-> ...
You get an instance from the static instance() method (or using the define ReaderSet).
Then you get a READER (PTEID_ReaderContext)
-> from this reader, you a CARD (PTEID_Card or derived class)
-> from this card, you get identity or address objects (PTEID_EId or PTEID_Address)
-> ...
RSA padding type
Which type of padding to be used while signing with RSA keys
Which type of padding to be used while signing with RSA keys
Singleton class - Factory used to obtain signing devices.
Optionally, opens a dialog to let user choose signing device type.
Optionally, opens a dialog to let user choose signing device type.
Interface class for objects with Signing capabilities.
Abstract base class for Smart card.
Class for the SOD document on an EID Card.
You can get such an object from PTEID_EIDCard::getSod().
You can get such an object from PTEID_EIDCard::getSod().
This class will contain information about the data to be included in the XML file returned by
PTEID_EIDCard::getXmlCCDoc
PTEID_EIDCard::getXmlCCDoc