API documentation - siimsuu1/MOPP-iOS GitHub Wiki

• MoppLib API calls and types

  • MoppLib Manager
    • setup
    • moppLibVersion
    • libdigidocppVersion
  • Container Actions
    • openContainer
    • createContainer
    • addDataFilesToContainer
    • removeDataFileFromContainer
    • getContainers
    • removeSignature
    • saveDataFile
    • addSignature
  • Card Actions
    • minimalCardPersonalData
    • cardPersonalData
    • isReaderConnected
    • isCardInserted
    • signingCertificate
    • authenticationCertificate
    • pin1RetryCount
    • pin2RetryCount
    • pukRetryCount
  • Pin Actions
    • changePuk
    • changePin1WithPin1
    • changePin1WithPuk
    • changePin2WithPin2
    • changePin2WithPuk
    • unblockPin1
    • unblockPin2
  • Crypto Actions
    • searchLdapData
    • encryptData
    • decryptData
    • parseCdocInfo
  • Mobile-ID service
    • mobileCreateSignature
    • cancelMobileSignatureStatusPolling
  • Smart-card Readers Manager
    • startDiscoveringReaders
    • stopDiscoveringReaders
    • setDelegate
    • MoppLibCardReaderManagerDelegate protocol
    • MoppLibCardReaderStatus enum
  • Constants and types
    • MoppLibSignatureStatus enum
    • MoppLibErrorCode enum
    • Notifications
    • Block type definitions
  • Response objects
    • MoppLibCertificateData
    • MoppLibPersonalData
    • MoppLibContainer
    • MoppLibDataFile
    • MoppLibSignature
    • MoppLibMobileCreateSignatureResponse
    • CdocInfo
    • Addressee
    • CryptoDataFile

First-time setup and version info

MoppLibManager.h, @interface MoppLibManager

- (void)setupWithSuccess:(EmptySuccessBlock)success andFailure:(FailureBlock)failure usingTestDigiDocService:(BOOL)useTestDDS;

None

Preliminary setup for MoppLib. Digidocpp is configured and initialized. TLS certificates cache is updated.

This method should be called before any other API call

MoppLibManager.h, @interface MoppLibManager

- (NSString *)moppLibVersion;

None

This method returns textual representation of MoppLib version

MoppLibManager.h, @interface MoppLibManager

- (NSString *)libdigidocppVersion;

None

This method returns textual representation of libdigidocpp version

Signed container actions:

• creating container
• validating container
• removing and adding signature to and from container
• adding and removing data files to and from container
• extracting data files from container

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)openContainerWithPath:(NSString *)containerPath success:(ContainerBlock)success failure:(FailureBlock)failure;

None

This method is used to validate container. If container is successfully validated then MoppLibContainer object is returned as ContainerBlock parameter

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)createContainerWithPath:(NSString *)containerPath withDataFilePaths:(NSArray *)dataFilePaths success:(ContainerBlock)success failure:(FailureBlock)failure;

None

This method creates a new container and validates it. MoppLibContainer object is returned from ContainerBlock if operations is successful

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)addDataFilesToContainerWithPath:(NSString *)containerPath withDataFilePaths:(NSArray *)dataFilePaths success:(ContainerBlock)success failure:(FailureBlock)failure;

None

This method adds files to container

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)removeDataFileFromContainerWithPath:(NSString *)containerPath atIndex:(NSUInteger)dataFileIndex success:(ContainerBlock)success failure:(FailureBlock)failure;

None

This method removes data file from container

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)getContainersWithSuccess:(void(^)(NSArray *containers))success failure:(FailureBlock)failure;

None

This method receives all available containers

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)removeSignature:(MoppLibSignature *)moppSignature fromContainerWithPath:(NSString *)containerPath success:(ContainerBlock)success failure:(FailureBlock)failure;

None

This method removes signature from container

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)container:(NSString *)containerPath saveDataFile:(NSString *)fileName to:(NSString *)path success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method extracts data file from the container and saves it to the specified location

MoppLibContainerActions.h, @interface MoppLibContainerActions

- (void)addSignature:(NSString *)containerPath withPin2:(NSString*)pin2 success:(void(^)(MoppLibContainer *container, BOOL signatureWasAdded))success failure:(FailureBlock)failure;

None

This method adds a signature to the container

ID-card actions

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)minimalCardPersonalDataWithSuccess:(PersonalDataBlock)success failure:(FailureBlock)failure;

None

This method receives minimal card personal data

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)cardPersonalDataWithSuccess:(PersonalDataBlock)success failure:(FailureBlock)failure;

None

This method receives card personal data

MoppLibCardActions.h, @interface MoppLibCardActions

+ (BOOL)isReaderConnected;

None

This method checks if reader is connected

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)isCardInserted:(BoolBlock) completion;

None

This method checks if card is inserted into the reader

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)signingCertificateWithSuccess:(CertDataBlock)success failure:(FailureBlock)failure;

None

This method provides information about signing certificate

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)authenticationCertificateWithSuccess:(CertDataBlock)success failure:(FailureBlock)failure;

None

This method provides information about authentication certificate

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)pin1RetryCountWithSuccess:(NumberBlock)success failure:(FailureBlock)failure;

None

This method provides number of PIN1 attempts left before PIN1 is blocked.

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)pin1RetryCountWithSuccess:(NumberBlock)success failure:(FailureBlock)failure;

None

This method provides number of PIN2 attempts left before PIN2 is blocked.

MoppLibCardActions.h, @interface MoppLibCardActions

+ (void)pukRetryCountWithSuccess:(NumberBlock)success failure:(FailureBlock)failure;

None

This method provides number of PUK attempts left before PUK is blocked.

MoppLinPinActions.h, @interface MoppLinPinActions

+ (void)changePukTo:(NSString *)newPuk withOldPuk:(NSString *)oldPuk success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method changes PUK code from old to new one

MoppLinPinActions.h, @interface MoppLibPinActions

+ (void)changePin1To:(NSString *)newPin1 withOldPin1:(NSString *)oldPin1 success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method changes PIN1 code using old PIN1

MoppLibPinActions.h, @interface MoppLibPinActions

+ (void)changePin1To:(NSString *)newPin1 withPuk:(NSString *)puk success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method changes PIN1 code using PUK code

MoppLibPinActions.h, @interface MoppLibPinActions

+ (void)changePin2To:(NSString *)newPin2 withOldPin2:(NSString *)oldPin2 success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method changes PIN2 code using old PIN2

MoppLibPinActions.h, @interface MoppLibPinActions

+ (void)changePin2To:(NSString *)newPin2 withPuk:(NSString *)puk success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method changes PIN2 code using PUK code

MoppLibPinActions.h, @interface MoppLibPinActions

+ (void)unblockPin1WithPuk:(NSString *)puk newPin1:(NSString *)newPin1 success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method unblocks PIN1 using PUK code

MoppLibPinActions.h, @interface MoppLibPinActions

+ (void)unblockPin2WithPuk:(NSString *)puk newPin2:(NSString *)newPin2 success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method unblocks PIN2 code using PUK

MoppLibCryptoActions.h, @interface MoppLibCryptoActions

- (void)searchLdapData:(NSString *)identifier success:(LdapBlock)success failure:(FailureBlock)failure;

None

This method is used to search ldap data

MoppLibCryptoActions.h, @interface MoppLibCryptoActions

- (void)encryptData:(NSString *)fullPath withDataFiles:(NSArray*)dataFiles withAddressees:(NSArray*)addressees success:(VoidBlock)success failure:(FailureBlock)failure;

None

This method is used to encrypt data

MoppLibCryptoActions.h, @interface MoppLibCryptoActions

- (void)decryptData:(NSString *)fullPath withPin1:(NSString*)pin1 success:(DecryptedDataBlock)success failure:(FailureBlock)failure;

None

This method is used to decrypt CDOC

MoppLibCryptoActions.h, @interface MoppLibCryptoActions

- (void)parseCdocInfo:(NSString *)fullPath success:(CdocContainerBlock)success failure:(FailureBlock)failure;

None

This method is used to parse and get info of CDOC container

MoppLibService.h, @interface MoppLibService

- (void)mobileCreateSignatureWithContainer:(NSString *)containerPath idCode:(NSString *)idCode language:(NSString *)language phoneNumber:(NSString *)phoneNumber withCompletion:(MobileCreateSignatureResponseBlock)completion andStatus:(SignatureStatusBlock)signatureStatus;

None

This is method is used to sign a container using Mobile-ID signing. Language parameter indicates in which language Mobile-ID challenge dialog in the phone is displayed.

MoppLibService.h, @interface MoppLibService

- (void)cancelMobileSignatureStatusPolling;

None

None

This method cancels Mobile-ID signing process

MoppLibCardReaderManager.h, @interface MoppLibCardReaderManager

- (void)startDiscoveringReaders;

None

None

Starts supported smart-card readers discovery. MoppLibCardReaderManagerDelegate can be used for discovered reader status change

MoppLibCardReaderManager.h, @interface MoppLibCardReaderManager

- (void)stopDiscoveringReaders;

None

None

Prevents supported smart-card readers discovery when called

MoppLibCardReaderManager.h, @interface MoppLibCardReaderManager

- (void)setDelegate:id<MoppLibCardReaderManagerDelegate> delegate;

None

Set's status change delegate for MoppLibCardReaderManager

MoppLibCardReaderManager.h, @interface MoppLibCardReaderManager

@protocol MoppLibCardReaderManagerDelegate

• (void)moppLibCardReaderStatusDidChange:(MoppLibCardReaderStatus)status;

Used to delegate card reader status to the protocol implementation.

MoppLibCardReaderManager.h, @interface MoppLibCardReaderManager

@protocol MoppLibCardReaderManagerDelegate

Smart-card reader status returned from MopplibCardReaderManagerDelegate's moppLibCardReaderStatusDidChange

MoppLibConstants.h

typedef NS_ENUM(int, MoppLibSignatureStatus)

MoppLibConstants.h

typedef NS_ENUM(NSUInteger, MoppLibErrorCode)

MoppLibConstants.h

MoppLibConstants.h

Objects returned from various MoppLib operations

MoppLibCertificateData.h, @interface MoppLibCertificateData

MoppLibPersonalData.h, @interface MoppLibPersonalData

MoppLibContainer.h, @interface MoppLibContainer

MoppLibDataFile.h, @interface MoppLibDataFile

MoppLibSignature.h, @interface MoppLibSignature

MoppLibMobileCreateSignatureResponse.h, @interface MoppLibMobileCreateSignatureResponse

CdocInfo.h, @interface CdocInfo

Addressee.h, @interface Addressee

CryptoDataFile.h, @interface CryptoDataFile