描述

VirgilSDK 是一款针对 Apple 平台服务的包装工具。它允许用户更容易地与 Virgil 服务交互。该框架负责组成正确的请求并将服务的响应解析为可用的模型类。

开始使用

VirgilSDK 框架应通过 CocoaPods 安装。所以，如果您不熟悉它，现在是时候安装 CocoaPods 了。打开您的终端窗口并执行以下行

$ sudo gem install cocoapods

它将要求您输入密码，然后安装 CocoaPods 的最新发布版本。CocoaPods 使用 Ruby 构建，可以通过 OS X 上默认的 Ruby 进行安装。

如果在安装过程中遇到任何问题，请参阅 cocoapods.org 以获取更多信息。

VirgilSDK 框架有 1 个依赖项

• VirgilFoundation - 这是一个用于执行基本安全操作的低级别 Virgil 框架，例如：创建密钥对、加密/解密数据以及签名/验证签名。

您不需要手动安装它。CocoaPods 会自动为您处理。

现在可以添加 VirgilSDK 到特定的应用中。所以

• 打开 Xcode，创建一个新项目（在 Xcode 菜单：文件->新->项目），或者使用以下方式导航到现有的 Xcode 项目

$ cd <Path to Xcode project folder>

• 在 Xcode 项目文件夹中创建一个新的文件，将其命名为 Podfile（首字母大写 P，不带任何扩展名）。以下示例显示了如何为一个 iOS 应用程序编写 Podfile。如果您计划使用其他平台，过程将非常相似。您只需更改平台到相应的值。有关平台值的更多信息，请参阅 此处。

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target '<Put your Xcode target name here>' do
    pod 'VirgilSDK'
end

• 返回到您的终端窗口并执行以下行

$ pod install

• 关闭 Xcode 项目（如果它仍然打开）。对于任何进一步的开发目的，您应使用 CocoaPods 为您创建的 .xcworkspace 文件。

到此为止，您应该能够将 VirgilSDK 功能用于您的代码。在下面的示例中查看最常见的任务。如果您在 CocoaPods 安装过程中遇到任何问题，请尝试在 cocoapods.org 上查找更多信息。

Swift笔记

尽管VirgilSDK主要使用Objective-C作为其主要语言，但它可能很容易在一个Swift应用程序中使用。按照《入门》部分中描述，将VirgilSDK安装后，需要执行以下操作：

• 在Swift项目中创建一个新的头文件。

• 将其命名为类似BridgingHeader.h的东西。

• 在该文件中放入以下行

@import VirgilFoundation;
@import VirgilSDK;

• 在Xcode构建设置中找到名为《Objective-C桥接头》的设置，将路径设置为您的BridgingHeader.h文件。请注意，此路径相对于您的Xcode项目文件夹。添加桥接头设置后，您应该能够使用SDK。

有关在同一个项目中使用Objective-C和Swift的更多信息，请点击此处。

Virgil应用程序令牌

在您对Virgil服务进行任何调用之前，需要获取一个应用程序令牌。请在此处注册或如果您已有账户，请登录。

此令牌对于对Virgil服务进行任何调用都是必要的。

创建密钥对

Objective-C

@import VirgilFoundation;

//...
VSSKeyPair *keyPair = [[VSSKeyPair alloc] init];
//...

Swift

//...
let keyPair = VSSKeyPair()
//...

可选地，可以创建一个受密码保护的密钥对

Objective-C

@import VirgilFoundation;

//...
VSSKeyPair *keyPair = [[VSSKeyPair alloc] initWithPassword:<#password#>];
//...

Swift

//...
let keyPair = VSSKeyPair(password:<#password#>)
//...

在发送任何请求之前设置VSSClient

对服务的请求是一个异步网络操作。VSSClient实例发送请求，当请求完成时，它会调用作为任何调用最后一个参数给定的完成处理程序块。为了使它工作，当请求完成时，VSSClient实例应该存在。创建一个将持有VSSClient实例的属性是一个好主意。

TBD

需求

需要iOS 8.x或更高版本，OSX 10.11或更高版本，WatchOS 2.0或更高版本，tvOS 9.0或更高版本。

许可

使用基于BSD 3-Clause License。请参阅LICENSE获取全部细节。