HIDContainer.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
 (c) 2015-2025, HID Global Corporation, part of ASSA ABLOY.
 All rights reserved.
          
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 - Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------- */
 
#import <Foundation/Foundation.h>
#import "HIDIdentifier.h"
#import "HIDProtectionPolicy.h"
#import "HIDConnectionConfiguration.h"
#import "HIDKeySpec.h"
#import "HIDKey.h"
#import "HIDContainerInitialization.h"
#import "HIDProgressListener.h"
#import "HIDTransaction.h"


@protocol HIDContainer

- (NSInteger)getId;

- (NSString*)getServerURL;

- (NSString*)getName;

- (BOOL)setName:(NSString*)name error:(NSError**)error;

- (NSString*)getUserId;

- (NSArray*)findKeys:(NSArray*)filter error:(NSError**)error;

- (NSString*)getProperty:(NSString*)propertyId error:(NSError**)error;

- (BOOL)setProperty:(NSString*)propertyId withValue:(NSString*)propertyValue error:(NSError**)error;

- (id<HIDProtectionPolicy>)getProtectionPolicy:(NSError**)error;

- (NSArray*)retrieveTransactionIds:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;

- (BOOL)setConnectionConfiguration:(HIDConnectionConfiguration*)config error:(NSError**)error;

- (BOOL)addKey:(HIDKeySpec*)keySpec withProtectionPolicyId:(HIDIdentifier*)protectionPolicyId withPassword:(NSString*)password error:(NSError**)error;
    
- (BOOL)isFIPSModeEnabled;

-(NSDate*)getOriginalCreationDate:(NSError**)error;

-(NSDate*)getCreationDate:(NSError**)error;

-(NSDate*)getExpiryDate:(NSError**)error;

-(NSDate*)getRenewalDate:(NSError**)error;

-(BOOL)isRenewable:(NSString*)sessionPassword  error:(NSError**)error;;

- (BOOL)renew:(HIDContainerRenewal*)config withSessionPassword:(NSString*) sessionPassword withListener:(NSObject<HIDProgressListener>*)listener error:(NSError**)error;

- (BOOL)updateDeviceInfo:(NSString*)propertyId withValue:(NSString*)propertyValue withPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;

- (id<HIDTransaction>) generateAuthenticationRequest:(NSString*)message withKey:(HIDIdentifier*) key error:(NSError**)error;

-(BOOL)shareContainer:(NSString*)password
           withSessionPassword:(NSString*)sessionPassword
           withKeychainId:(NSString*)keychainId withAppGroupId:(NSString*)appGroupId
           error:(NSError**)error;
 
@end