iOS用のAPI

March 11, 2024

寄稿者:

iOS用のXenMobile APIはObjective-Cに基づいています。ここでは、Citrix Endpoint Management APIを機能別に概説し、APIの定義を説明します。

アプリの管理

isAppManaged

Secure Hubの操作

isMDXAccessManagerInstalled
logonMdxWithFlag
isAppLaunchedByWorxHome

MDXポリシー

getValueOfPolicy

共有コンテナ

getVaultDataFromVault
saveVaultData
updateAndSynchronizeVaultItem
updateAndSynchronizeVaultItems
deleteVault
deleteVaultWithError

ユーザーデータ

managedUserInformation

クラスMdxManager

メソッド

getValueOfPolicy

+(NSString*) getValueOfPolicy:(NSString*)policyName error:(NSError **) error;

管理対象アプリの場合、Citrix Endpoint Management管理者が設定したポリシー値を返します。非管理対象のPremiumアプリの場合、Applications/Citrix/MDXToolkit/data/MDXSDK/default_policies.xmlに設定されたポリシー値を返します。非管理対象のGeneralアプリの場合、nilを返します。

パラメーター：

policyName – default_policies.xmlで検索するポリシーの名前。

例：

+(NSString*) getValueOfPolicy:(NSString*)DisableCamera error:(NSError **) error;
isMDXAccessManagerInstalled

+(BOOL) isMDXAccessManagerInstalled: (NSError **) error;

Secure Hubがインストールされているか確認します。インストールされている場合、アプリが管理対象ではない場合もアプリのMDX制御は有効です。Secure Hubがインストールされている場合、trueを返します。
isAppManaged

+(BOOL) isAppManaged;

アプリが現在MDXによって管理されているかを確認します。つまり、MDXポリシーバンドルはXMLファイルとしてアプリに組み込まれています。Citrix Endpoint Managementバックエンドインフラストラクチャ（キーコンテナ）に対して、アプリデータベースのデータ暗号化にMDXが使用するデータ暗号化部分キー（シークレット）がクエリされます（iOS 9以降）。アプリが管理対象の場合、trueを返します。
logonMdxWithFlag

+(BOOL) logonMdxWithFlag:(BOOL)force error:(NSError**) error;

Secure HubでMDXログオン要求を開始します。
isAppLaunchedByWorxHome

+(BOOL) isAppLaunchedByWorxHome;

アプリ間のURL要求が、Secure Hubからか、デバイス上の他のアプリからなのかを確認します。これは、アプリがMDX制御の通信を認識する必要がある場合に必要です。iOSでは、アプリが特定のURLスキーマを登録できます。URLスキーマはURLの最初の部分です（コロンの前まで。コロンは含みません）。URLがhttp://で始まる場合、スキーマはhttpです。

MDX対応のアプリおよびSecure Hubは、カスタムURLスキーマを使用して通信します。たとえば、他のアプリからのmailto: URLを処理するには、Secure MailはURLスキーマctxmailが必要です。他のアプリからのhttp URLまたはhttps URLを処理するには、Secure WebはそれぞれURLスキーマctxmobilebrowserまたはctxmobilebrowsersが必要です。MDXアプリのURLスキーマポリシーおよび許可するURLポリシーについて詳しくは、「iOSアプリのMDXポリシー」を参照してください。

次のUIApplication代理イベント呼び出しの最中または後で、クエリが実行される時間や場所に関係なく、正確な結果を返します。
- アプリがホーム画面またはopenURL呼び出しからロードする場合：
```
 application:willFinishLaunchingWithOptions:

 application:didFinishLaunchingWithOptions:

 applicationDidFinishLaunching:
```
- ユーザーがデバイスホーム画面からアプリをアクティブ化または非アクティブ化する場合：
```
 applicationDidBecomeActive:
```
重要：

applicationWillEnterForeground:の実行中にクエリを実行しないでください。
- openURL呼び出しによってアプリをアクティブ化または非アクティブ化する場合：
```
 application:openURL:sourceApplication:annotation:

 application:handleOpenURL:
```
managedUserInformation

extern __attribute__((visibility ("default"))) NSString *const kXenMobileUsername; +(NSDictionary*) managedUserInformation;

ユーザーのサインイン状態に関係なく、MDX管理対象アプリを実行する登録されたユーザーのUserNameを含む文字列を返します。ユーザーが登録されていない場合、アプリが管理対象でない場合、またはアプリがラップされていない場合は、空の文字列を返します。

Class XenMobileSharedKeychainVault

メソッド

initWithVaultName

- (instancetype) initWithVaultName:(NSString*)vaultName accessGroup:(NSString*)accessGroup;

Citrix Endpoint Management共有コンテナを初期化します。

共有コンテナAPIを使用して、同じキーチェーンアクセスグループを持つアプリ間で管理対象コンテンツを共有します。たとえば、登録されたアプリを介してユーザー証明書を共有できるため、アプリはSecure Hubからではなくセキュアなコンテナから証明書を取得できます。

パラメーター：

vaultName – Citrix Endpoint Management共有コンテナの名前。

accessGroup – キーチェーンアクセスグループの名前。これは、TEAMID_A.appOriginalBundleIDという名前のデフォルトのMDXアクセスグループ、またはアプリ間でデータを共有するために使用するキーチェーンアクセスグループの場合があります。
コンテナデータ型プロパティ
```
   @property(nonatomic,readonly) BOOL exists;

   @property(nonatomic,readonly) BOOL isAccessible;

   @property(nonatomic,strong) NSMutableDictionary* vaultData
   
```
コンテナを初期化した後で、以下のコンテナデータ型プロパティが返されます。

exists – 指定されたvaultNameのコンテナが検出されたかどうかを示します。

isAccessible – 指定されたaccessGroupにコンテナがあるかどうか、およびコンテナにアクセスできるかどうかを示します。

vaultData – 共有コンテナのコンテンツです。コンテナを初めて初期化する場合、vaultDataはnilディクショナリです。
getVaultDataFromVault

+ (NSDictionary*) getVaultDataFromVault:(NSString*)vaultName accessGroup:(NSString*)accessGroup error:(NSError *__autoreleasing *)error;

Citrix Endpoint Management共有コンテナからデータを読み取ります。これは、以下に示す、コンテナデータを読み取る3つの方法のうちの1つです。
- getVaultDataFromVault:accessGroup:errorを直接使用する。
- XenMobileSharedKeychainVaultインスタンスを作成して、vaultDataプロパティを読み取る。
- XenMobileSharedKeychainVaultインスタンスを作成し、-(BOOL) loadDataWithError:(NSError *__autoreleasing *)error;を使用しvaultDataプロパティを読み取って、コンテナデータを再読み込みします。
サンプルコードについては、この記事の「共有コンテナのサンプル」を参照してください。

パラメーター：

vaultName – Citrix Endpoint Management共有コンテナの名前。

accessGroup – キーチェーンアクセスグループの名前。これは、TEAMID_A.appOriginalBundleIDという名前のデフォルトのMDXアクセスグループ、またはアプリ間でデータを共有するために使用するキーチェーンアクセスグループの場合があります。
saveVaultData

+ (BOOL) saveVaultData:(NSDictionary*)vaultData toVault:(NSString*)vaultName accessGroup:(NSString*)accessGroup error:(NSError *__autoreleasing *)error;

Citrix Endpoint Management共有コンテナにデータを保存します。これは、以下に示す、コンテナデータを保存する3つの方法のうちの1つです。
- saveVaultData:toVault:accessGroup:error:を直接使用する。
- updateAndSynchronizeVaultItem:またはupdateAndSynchronizeVaultItemsを使用する（この表の次の部分で説明）。
- XenMobileSharedKeychainVaultインスタンスを作成し、コンテナデータをロードして変更し、データを同期させて、- (BOOL)synchronizeWithError:(NSError *__autoreleasing *)error;を使用する。
サンプルコードについては、この記事の「共有コンテナのサンプル」を参照してください。

パラメーター：

vaultData – Citrix Endpoint Management共有コンテナに保存するデータ。共有コンテナに保存するデータは、@{@”username”:@”andreo”}などのキー/値ペアのディクショナリです。

vaultName – Citrix Endpoint Management共有コンテナの名前。

accessGroup – キーチェーンアクセスグループの名前。これは、TEAMID_A.appOriginalBundleIDという名前のデフォルトのMDXアクセスグループ、またはアプリ間でデータを共有するために使用するキーチェーンアクセスグループの場合があります。
updateAndSynchronizeVaultItem

updateAndSynchronizeVaultItems

- (BOOL)updateAndSynchronizeVaultItem:(NSString*)vaultItem withValue:(id)itemValue error:(NSError *__autoreleasing *)error;

- (BOOL)updateAndSynchronizeVaultItems:(NSDictionary*)vaultItems error:(NSError *__autoreleasing *)error;

Citrix Endpoint Management共有コンテナのデータを更新します。この方法を使用するためには、XenMobileSharedKeychainVaultインスタンスを作成し、コンテナデータアイテムを追加または更新してこのインスタンスを同期します。たとえば、既存のコンテナエントリに{a:123, b:234, c:305}を使用している場合、このAPIをデータに使用して{c:345, d:456}を更新すると、このAPIによってコンテナデータが{a:123, b:234, c:345, d:456}に更新されます。サンプルコードについては、この記事の「共有コンテナのサンプル」を参照してください。

コンテナデータを保存する他の2つの方法については、上記のsaveVaultDataを参照してください。

パラメーター：

vaultItem – @{@";username::@";andreo"}の形式の単一のキー/値ペア。

vaultItems – キー/値ペアのリスト。
deleteVault

+ (BOOL) deleteVault:(NSString*)vaultName accessGroup:(NSString*)accessGroup error:(NSError *__autoreleasing *)error;

指定の共有コンテナを削除します。

パラメーター：

vaultName – Citrix Endpoint Management共有コンテナの名前。

accessGroup – 削除対象のコンテナによって使用されているキーチェーンアクセスグループの名前。
deleteVaultWithError

-(BOOL) deleteVaultWithError:(NSError *__autoreleasing *)error;

XenMobileSharedKeychainVaultインスタンスにより返された共有コンテナを削除します。deleteVaultWithErrorで削除した後で、オブジェクトを解放する必要があります。

共有コンテナのサンプル

#import "XenMobileSharedKeychainVault.h"

@interface ClassA ()
...
@property(nonatomic,strong) XenMobileSharedKeychainVault* XenMobileSharedKeychainVault;
...
@end

@implementation ClassA
...
@synthesize XenMobileSharedKeychainVault = _XenMobileSharedKeychainVault;


...
#ifdef USE_CLASS_INSTANCE_METHODS
-(XenMobileSharedKeychainVault*)XenMobileSharedKeychainVault
{
if(_XenMobileSharedKeychainVault==nil) {
_XenMobileSharedKeychainVault = [[XenMobileSharedKeychainVault alloc]
      initWithVaultName:<VAULT_NAME>
      accessGroup:kXenMobileKeychainAccessGroup];
}
return _XenMobileSharedKeychainVault;
}
#endif

-(void)read
{
NSError* error=nil;
#ifdef USE_CLASS_INSTANCE_METHODS
NSDictionary* vaultDictionary = nil;
if([self.XenMobileSharedKeychainVault loadDataWithError:&error]) {
vaultDictionary = [self.XenMobileSharedKeychainVault vaultData];
}
#else
NSDictionary* vaultDictionary = [XenMobileSharedKeychainVault
      getVaultDataFromVault:<VAULT_NAME>
      accessGroup:kXenMobileKeychainAccessGroup error:&error];
#endif

}

-(void)save
{
NSError* error=nil;
/// check error handling here...

NSDictionary* dictToSave = @{<VAULT_DATA_DICTIONARY_OBJECTS>};
#ifdef USE_CLASS_INSTANCE_METHODS
#ifdef USE_CLASS_INSTANCE_METHODS_TO_UPDATE
BOOL result = [self.XenMobileSharedKeychainVault
      updateAndSynchronizeVaultItems:dictToSave error:&error];
#else
self.XenMobileSharedKeychainVault.vaultData = [NSMutableDictionary
      dictionaryWithDictionary:dictToSave];
BOOL result = [self.XenMobileSharedKeychainVault synchronizeWithError:&error];
#endif
#else
BOOL result = [XenMobileSharedKeychainVault
      saveVaultData:dictToSave toVault:<VAULT_NAME>
      accessGroup:kXenMobileKeychainAccessGroup error:&error];
#endif

}

-(void)delete
{
NSError* error=nil;
#ifdef USE_CLASS_INSTANCE_METHODS
BOOL result = [self.XenMobileSharedKeychainVault deleteVaultWithError:&error];
#else
BOOL result = [XenMobileSharedKeychainVault deleteVault:<VAULT_NAME>
      accessGroup:kXenMobileKeychainAccessGroup error:&error];
#endif

}

...

@end
<!--NeedCopy-->

このコンテンツの正式なバージョンは英語で提供されています。Cloud Software Groupドキュメントのコンテンツの一部は、お客様の利便性のみを目的として機械翻訳されています。Cloud Software Groupは機械翻訳されたコンテンツを管理していないため、誤り、不正確な情報、不適切な用語が含まれる場合があります。英語の原文から他言語への翻訳について、精度、信頼性、適合性、正確性、またはお使いのCloud Software Group製品またはサービスと機械翻訳されたコンテンツとの整合性に関する保証、該当するライセンス契約書またはサービス利用規約、あるいはCloud Software Groupとのその他すべての契約に基づき提供される保証、および製品またはサービスのドキュメントとの一致に関する保証は、明示的か黙示的かを問わず、かかるドキュメントの機械翻訳された範囲には適用されないものとします。機械翻訳されたコンテンツの使用に起因する損害または問題について、Cloud Software Groupは責任を負わないものとします。

この情報は役に立ちましたか?

iOS用のAPI

March 11, 2024

寄稿者:

March 11, 2024

寄稿者:

この情報は役に立ちましたか?