blob: 42b474ef8d40d5f12d71d5fcb38870a3fc370e84 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
<h1>SDLSecurityType Protocol Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-appId">appId</a></li>
<li><a href="#section--initializeWithAppId:completionHandler:">-initializeWithAppId:completionHandler:</a></li>
<li><a href="#section--stop">-stop</a></li>
<li><a href="#section--runHandshakeWithClientData:error:">-runHandshakeWithClientData:error:</a></li>
<li><a href="#section--encryptData:withError:">-encryptData:withError:</a></li>
<li><a href="#section--decryptData:withError:">-decryptData:withError:</a></li>
<li><a href="#section-+availableMakes">+availableMakes</a></li>
</ul>
<h3>Overview</h3>
<p>A protocol used by SDL Security libraries.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Used internally
</div>
<section class="section task-group-section">
<h3 id="section-appId">
appId
</h3>
<p>The app id of the app</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appId</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section--initializeWithAppId:completionHandler:">
-initializeWithAppId:completionHandler:
</h3>
<p>Initialize the SDL security library with the app’s id and a completion handler</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">initializeWithAppId</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">withAppId</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Error</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>appId</dt>
<dd><p>The app’s id</p></dd>
<dt>completionHandler</dt>
<dd><p>A handler for when the security library is initialized</p></dd>
</dl>
<h3 id="section--stop">
-stop
</h3>
<p>Stop the security library</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre>
<h3 id="section--runHandshakeWithClientData:error:">
-runHandshakeWithClientData:error:
</h3>
<p>Run the SSL/TLS handshake</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">runHandshakeWithClientData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span>
<span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span>
<span class="n">error</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">runHandshake</span><span class="p">(</span><span class="n">withClientData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Data</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>data</dt>
<dd><p>The client data for the handshake</p></dd>
<dt>error</dt>
<dd><p>A returnable error</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The server handshake data</p>
</div>
<h3 id="section--encryptData:withError:">
-encryptData:withError:
</h3>
<p>Encrypt data using SSL/TLS</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">encryptData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span>
<span class="nf">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">encryptData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Data</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>data</dt>
<dd><p>The data to encrypt</p></dd>
<dt>error</dt>
<dd><p>A returnable error</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The encrypted data</p>
</div>
<h3 id="section--decryptData:withError:">
-decryptData:withError:
</h3>
<p>Decrypt data using SSL/TLS</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">decryptData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span>
<span class="nf">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">decryptData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Data</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>data</dt>
<dd><p>The data to decrypt</p></dd>
<dt>error</dt>
<dd><p>A returnable error</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The decrypted data</p>
</div>
<h3 id="section-+availableMakes">
+availableMakes
</h3>
<p>The vehicle makes this security library covers</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="n">availableMakes</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">availableMakes</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Set</span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre>
<div>
<h4>Return Value</h4>
<p>The makes</p>
</div>
</section>
|
