AGSCredential.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <Foundation/Foundation.h>
#import <Security/Security.h>



typedef  {
    AGSCredentialErrorTypeNone  = 0,
    AGSCredentialErrorTypeInvalidCredentials ,
    AGSCredentialErrorTypeSSLRequired ,
    AGSCredentialErrorTypeUnknown 
};

@interface AGSCredential : NSObject <NSCopying, NSCoding>

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, copy) NSString *username;

@property (nullable, nonatomic, copy) NSString *password;

@property (nullable, nonatomic, strong) NSURL *tokenUrl;

@property (nullable, nonatomic, copy, readonly) NSString *referer;


@property (nullable, nonatomic, copy) NSString *token;

@property (nullable, nonatomic, assign) SecIdentityRef identity;

@property (nonatomic, assign, readwrite, getter=isCachingEnabled) BOOL cachingEnabled;

@property (nullable, nonatomic, copy) NSData *identityCertificateData;

@property (nullable, nonatomic, copy) NSString *identityCertificatePassword;

#pragma mark -
#pragma mark initializers

- (instancetype)initWithUser:(NSString*)username password:(NSString*)password;

- (instancetype)initWithIdentityRef:(SecIdentityRef)identityRef;

- (instancetype)initWithToken:(NSString*)token referer:(nullable NSString*)referer;

- (nullable instancetype)initWithIdentityCertificateData:(NSData *)data password:(NSString *)password;

+ (instancetype)credentialWithUser:(NSString*)username password:(NSString*)password;

#pragma mark -
#pragma mark methods

+ (nullable NSArray<id>*)identitiesForProtectionSpace:(nullable NSURLProtectionSpace*)protectionSpace ;

+ (nullable SecIdentityRef)importCertificateData:(NSData*)data password:(NSString*)password overwrite:(BOOL)overwrite error:(NSError**)error ;

+ (OSStatus)removeIdentityFromKeychain:(SecIdentityRef)identityRef ;

- (nullable NSString*)authenticatingHost;

@end