forked from cisco/libest
-
Notifications
You must be signed in to change notification settings - Fork 1
/
intro.txt
650 lines (554 loc) · 28.2 KB
/
intro.txt
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
/**
@mainpage Introduction to libEST
This document describes libEST, a library that implements the
Enrollment over Secure Transport protocol (RFC 7030). This protocol is a
replacement for SCEP. It allows X509 certificates to be provisioned
on end-user devices and network infrastructure devices. Users of
libEST are encouraged to read RFC 7030 prior to using the API.
See the @ref Features section for more detailed information.
libEST provides a subset of the EST specification. The
following message flows are provided:
@latexonly
\begin{itemize}
\item cacerts
\item csrattrs
\item simpleenroll
\item simiplereenroll
\item serverkeygen
\end{itemize}
@endlatexonly
This document is organized as follows. The first chapter provides
background material on EST and an overview of libEST. The subsequent
chapters provide a detailed reference to the libEST API and related
functions. The reference material is created automatically (using the
doxygen utility) from comments embedded in some of the C header
files.
@section LICENSE License and Disclaimer
libEST is distributed under the following license, which is included
in the source code distribution. It is reproduced in the manual in
case you attained the library from another source.
@latexonly
\begin{quote}
Copyright (c) 2013-2019 Cisco Systems, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
\begin{itemize}
\item Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
\item 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.
\item Neither the name of the Cisco Systems, Inc. nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
\end{itemize}
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 HOLDERS 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.
\end{quote}
@endlatexonly
@section Features Supported Features
The EST specification defines requirements for enrolling X509
certifications for end-entities, Registration Authorities (RA), and
Certificate Authorities (CA). There are six message flows described
in the EST specification. libEST supports a subset of these
message flows, but is designed to operate as a client, proxy, or server.
libEST supports the following five EST message flows:
@latexonly
\begin{itemize}
\item cacerts
\item csrattrs
\item simpleenroll
\item simiplereenroll
\item serverkeygen
\end{itemize}
@endlatexonly
@latexonly
The following message flows are currently not supported:
\begin{itemize}
\item fullcmc
\end{itemize}
@endlatexonly
The user should be aware that it is possible to misuse this library,
which may result in inadequate security. If you are implementing a
feature using this library, you will want to read the Security Considerations
section of the EST specification (RFC 7030). In addition, it is important that
you read and understand the terms outlined in the @ref LICENSE section.
@section Installing Installing and Building libEST
@latexonly
To install libEST, download the latest release of the distribution.
The naming convention of the tarball is
\texttt{libEST-A.B.gz}, where \texttt{A} is the
major release number and \texttt{B} is
the minor release number, and \texttt{gz} is the file
extension. Users are encouraged to use the most recent release.
Unpack the distribution and
extract the source files; the directory into which the source files
will go is named \texttt{libEST-A-B}.
libEST uses the GNU \texttt{autoconf} and \texttt{make}
utilities\footnote{BSD make may not work; if both versions of make
are on your platform, you may have to invoke GNU make as \texttt{gmake}.}. In
the \texttt{libest} directory, run the configure script and then make:
\begin{verbatim}
./configure [ options ]
make
make install
\end{verbatim}
This package has been tested on both 32 and 64 bit Linux systems running
CentOS and Ubuntu. The OpenSSL development package should be installed
on the system. libEST is designed to work
with the OpenSSL 1.0.2 API or above. You can use the --with-ssl-dir option
with the ./configure command to specify the location of the OpenSSL
installation on the host system.
\subsection{Static Linking}
By default, both the shared and statically linked version of
libEST are built. If only the static version is to be used,
the --disable-shared option should be used with ./configure.
This will disbale the generation of the shared version of the libEST
library, forcing the linker to use the statically linked version.
\subsection{LibCoAP Library}
libEST is dependent upon the libcoap library to communicate via CoAP. The
libcoap library must first be obtained from Github
(https://github.com/obgm/libcoap/releases). Cisco specific changes exist that
must be applied to libcoap before it is built and installed. The patch
containing the Cisco specific changes to libcoap is libcoap.cisco.xxx.patch
(xxx set to the specific build version) and is found in the top level
directory of the libEST code base.
\begin{verbatim}
tar -xvf libcoap-4.2.0-rc3.tar.gz
cd libcoap-4.2.0-rc3/libcoap
cp <install path to libEST code base>/libcoap.cisco.109.patch .
patch -i libcoap.cisco.109.patch -p 1
\end{verbatim}
Libcoap needs to built using OpenSSL 1.1.0 or greater. The OpenSSL version
used to build this dependency should be the same as the version used when
building libEST. Once the Cisco specific changes have been applied to the
libcoap source, perform the following commands to build and install:
\begin{verbatim}
export _OPENSSL_DIR=<OpenSSL 1.1.x+ install dir>
export CFLAGS="-I${_OPENSSL_DIR}/include"
export LDFLAGS="-L${_OPENSSL_DIR}/lib"
export PKG_CONFIG_PATH="${_OPENSSL_DIR}/lib/pkgconfig"
./configure [--prefix=<install-dir>] --disable-documentation --with-openssl\
--with-cisco
make
make install
\end{verbatim}
If the ./configure was not present, run the following command and rerun the
above commands:
\begin{verbatim}
./autogen.sh
\end{verbatim}
When configuring the libEST build, the --with-libcoap-dir option is used to
point to the installed libcoap library to be used.
If the prefix option was used to specify a new path to install to, make sure to
add the libcoap lib folder to LD\_LIBRARY\_PATH so that it can be linked in at
runtime. See the example application code for an example application using this
feature's APIs.
\subsection{Libcurl Library}
libEST can be built with libcurl to allow libEST to be used in SOCKS/HTTP
proxy mode. libEST has been built and tested with the following versions of
libcurl:
\begin{itemize}
\item 7.60.0
\item 7.62.0
\item 7.64.0
\end{itemize}
Libcurl needs to built using OpenSSL 1.0.2 or greater. The OpenSSL version used
to build this dependency should be the same as the version used to build
libEST. To perform this build of libcurl on Linux download the libcurl tarball
from the libcurl download page, expand it, and run the following commands:
\begin{verbatim}
export _OPENSSL_DIR=<OpenSSL 1.0.2+ install dir>
export CPPFLAGS="-I$_OPENSSL_DIR/include"
export LDFLAGS="-L$_OPENSSL_DIR/lib"
export LD\_LIBRARY\_PATH="$_OPENSSL_DIR/lib"
./configure [--prefix=<install-dir>] --with-ssl=${_OPENSSL_DIR}
make
make install
\end{verbatim}
When configuring the libEST build, the --with-libcurl-dir option is used to
point to the installed libcurl library to be used. If the prefix option was
used to specify a new path to install to, make sure to add the libcurl lib
folder to LD\_LIBRARY\_PATH so that it can be linked in at runtime.
\subsection{URIParser Library}
libEST can be built with uriparser to allow libEST to support the use of
an URI path segment inside an EST request. libEST has been built and tested
with the following versions of uriparser:
\begin{itemize}
\item 0.8.5
\item 0.9.1
\end{itemize}
To build uriparser on Linux download the uriparser tarball from the uriparser
download page, expand it, and run the following commands:
\begin{verbatim}
./configure [--prefix=<install-dir>]
make
make install
\end{verbatim}
When configuring the libEST build, the --with-uriparser-dir option is used to
point to the installed uriparser library to be used. If the prefix option was
used to specify a new path to install to, make sure to add the uriparser
lib folder to LD\_LIBRARY\_PATH so that it can be linked in at runtime.
\subsection{Release builds}
By default libEST includes debug symbols in the target binary. To perform
a production release build that does not contain debug symbols, the
following procedure can be used:
\begin{verbatim}
./configure [ options ]
make
make install-strip
\end{verbatim}
@endlatexonly
@latexonly
\subsection{Java build}
@endlatexonly
<b>NOTE: JEST is no longer supported. The code and the following instructions are
included for teams that wish to use it as a starting point for
developing their own JNI to LibEST.</b>
@latexonly
libEST is used by JEST, which provides Java support for EST client-side
operations. JEST requires the libEST libary (libest.so). JEST
provides a Java wrapper class to invoke the client-side API available in
libest.so. JEST consists of a native JNI library (libjest.so) and
an associated Jar file containg the wrapper class. This allows your Java
applications to leverage libEST (via JEST).
If you plan to use JEST for Java support, you will still need to
build libEST. Use the \texttt{--enable-jni} option when
configuring libEST. When this option is used, the libciscojest.so
target is built in addition to the libest.so target. libjest.so is
installed into the same directory as libest.so (/usr/local/est/lib by default).
You will need to ensure the LD\_LIBRARY\_PATH is configured properly for your
JVM to include the libEST and JEST native libraries.
The following procedure shows how to build and install libEST with Java support:
\begin{verbatim}
./configure --enable-jni
make
make install
\end{verbatim}
The JEST Jar file is distributed separately from libEST. The Jar file
should be included into your JVM using the CLASSPATH setting. Please refer
to the JEST API documentation for using JEST within your Java
application.
@endlatexonly
@section Examples Example Code
@latexonly
Several example applications are included in the release tarball. These
are located in the \texttt{/example} subdirectory.
\begin{center}
\begin{tabular}{ll}
\hline
Example Applications & Function tested \\
\hline
client-simple & Example EST client application using the easy provision API \\
client & Example EST client application using the granular API \\
server & Example EST server application using OpenSSL CA \\
proxy & Example EST proxy application acting as an RA \\
\hline
\end{tabular}
\end{center}
There are README files in each of the example subdirectories. The
samples are built automatically when libEST is configured and
compiled. When running the example server application, there is a
script called createCA.sh that must be run once to create the
root CA certificate and certificate chain that is required for
running the EST example server. This script uses the host-resident
copy of OpenSSL on the system to create a CA database. Your
host-resident copy of OpenSSL should provide support for ECC
operations.
Note, the example code is not suitable for including into
commercial software. The examples are primarily used to test
the libEST library and to show how the API should be used. The
example code does not have all the appropriate error handling
and robust design required for commercial software. For example,
the OpenSSL CA used by the example EST server is not thread safe and
provides no means to enforce certificate policy.
@endlatexonly
@section Overview EST Overview
EST provides for a standards based mechanism to provision X509 certificates
from either an RA or CA. An entity that desires to attain a valid
X509 certificate bound to a trust point acts as an EST client and
communicates with either an RA or a CA to request and receive an
X509 certificate from a trusted CA. libEST provides
both client-side and server-side capabilities to operate as any
role in the EST enrollment process (end-entity, RA, or CA).
It is important to note that libEST is not a CA. libEST is only
the EST stack, which can be used by a CA to comply with RFC 7030.
The EST specification requires the use of TLS for transport. This
allows all the entities participating in the enrollment process to
verify the identity of each other. TLS also provides privacy on the
communication channel between the EST client and RA/CA.
Using the simple case of an
EST client communicating with an EST enabled CA server, the following
minimal setup is required prior to initiating the enrollment process:
@latexonly
\begin{itemize}
\item A server certificate must be provisioned for the EST enabled
CA server. This allows the CA to identify itself to EST clients.
\item The certificate chain used to sign the server certificate
must be provided to libEST on the server side.
\item The root certificate of the chain used to sign the server
certificate should be pre-provisioned on the EST client. This allows
the EST client to verify the identity of the EST enabled CA
server\footnote{This statement does not address the bootstrap enrollment process. The bootstrap method is supported by libEST, but requires additional configuration.}. If this root certificate can not be pre-provisioned, then
a fingerprint of the EST server identity certificate can be used by the
EST client to verify the EST server identity.
\end{itemize}
@endlatexonly
With the above setup requirements satisfied, the enrollment process
consists of the following procedure:
@latexonly
\begin{itemize}
\item The EST client issues the /cacerts request to the server. During
this process the EST client verifies the server identity using the
pre-provisioned root certificate described above, or using a fingerprint
of the server certificate.
\item The EST client replaces the pre-provisioned trusted root certificates
with the certificates provided by the EST enabled CA server in the /cacerts
response. This new certificate chain is used for all future client-side
EST operations. The client should persist this new trust chain for
future use, such as certificate renewal.
\item The EST client issues the /csrattrs request to the server. The
server responds by providing X509 attributes that should be included in
the forthcoming PKCS10 CSR request. The required X509 attributes are
derived from the certificate policy configured on the CA.
\item The EST client generates a PKCS10 CSR and includes any specific
X509 attributes required by the server based on the response in the /csrattrs
request.
\item The EST client sends the PKCS10 CSR to the server using the
/simpleenroll request. The EST enabled CA server will sign the CSR and
return the X509 certificate to the client.
\end{itemize}
@endlatexonly
@section ESTClient EST Client Operation
Applications that need to provision X509 certificates can utilize
libEST in client mode. libEST provides an API that performs the
steps in the enrollment process described in the @ref Overview section.
The first step when using the API is to create an EST context. Once
created, the context is used for subsequent API calls into the libEST
library. The EST specification allows for several authentication methods.
This includes HTTP basic authentication, HTTP digest authentication, and
certificate based authentication. The example client code provided
with the libEST distribution tarball shows how to use the various capabilities
in the libEST API, including the various authentication methods.
There are two methods for provisioning a certifice while operating
in client mode. The first is the easy provision API, which provides
a simplified API that encapsulates all the client-side EST operations
into a single enroll operation. The second method is to use the
granular API for performing the /cacerts, /csrattrs, and /simpleenroll
operations individually. The easy provision API is limited in that
the client can only specify the X509 Common Name value in the certificate
request. If the CA certificate policy is configured such that additional
X509 attributes are required to be supplied by the client, then the
easy provision API should not be used.
@latexonly
\subsection{Easy Provision API}
@endlatexonly
The easy provision API provides a simplied entry point into libEST to
enroll a certificate request with a CA. This API encapsulates the
recommended steps as defined in RFC 7030, which includes:
@latexonly
\begin{itemize}
\item Attain a fresh copy of the EST server CA certificates.
\item Request the CSR attributes from the EST server to determine if proof-of-possession is required.
\item Issue the simple enroll request to the EST server.
\end{itemize}
@endlatexonly
The following procedure outlines the steps to utilize the easy provision API:
1. Invoke the est_apps_startup() helper function, which
initializes the OpenSSL library. This may not be required if
your application has already initialized OpenSSL elsewhere.
2. Invoke est_client_init() to attain an EST context. Use the
pre-provisioned trusted root certificates.
3. Invoke est_client_set_auth() to specify the HTTP username
and password to be used. Optionally, an existing X509 certificate
can be used to identify the client to the EST server. For example,
a previously issued certificate or a bootstrap certificate could
be used. The HTTP username is optional when a client certificate
is provided.
4. Invoke est_client_set_server() to specify the IP address of the
EST server, which may be either an RA or CA.
5. Invoke est_client_provision_cert() to create a PKCS10 CSR and
forward it to the EST server, expecting the EST server to return
the signed X509 certificate.
6. Invoke est_client_copy_enrolled_cert() to copy the X509 cert provided
by the EST server to local storage.
7. Invoke est_client_copy_cacerts() to retrieve the latest trust chain that
was provided by the EST server. These certs should be persisted for future use.
8. Invoke est_destroy() to remove the EST context.
@latexonly
\subsection{Full Provision API}
@endlatexonly
While the easy provision API is easier to use, it does not allow the application
to specify X509 attributes in the PKCS10 CSR other than the Common Name. Because
the CA may be configured with policy requiring the certificate requestor to provide
additional X509 attributes in the CSR, the easy provision API may not be suitable
for your application. When this occurs, libEST provides a more granular API that
allows your application to create the PKCS10 CSR itself, rather than having libEST
create the CSR on behalf of your application. This allows your application to include
any required X509 attributes in the CSR. The following steps outline the procedure
for using the granular API:
1. Invoke the est_apps_startup() helper function, which
initializes the OpenSSL library. This may not be required if
your application has already initialized OpenSSL elsewhere.
2. Invoke est_client_init() to attain an EST context. Use the
pre-provisioned trusted root certificates.
3. Invoke est_client_set_auth() to specify the HTTP username
and password to be used. Optionally, an existing X509 certificate
can be used to identify the client to the EST server. For example,
a previously issued certificate or a bootstrap certificate could
be used. The HTTP username is optional when a client certificate
is provided.
4. Invoke est_client_set_server() to specify the IP address of the
EST server, which may be either an RA or CA.
5. Invoke est_client_get_cacerts() and est_client_copy_cacerts() to
retrieve the latest trust chain from the EST server.
6. Invoke est_destroy() to clean the EST context.
7. Invoke est_client_init() to attain a new EST context. Unlike
step 2, we use the new CA certs just attained in step 5. Repeat
steps 3 and 4 again too.
8. Invoke est_client_get_csrattrs() to retrieve the required
X509 attributes from the CA.
9. Generate a public/private key pair if needed.
10. Using OpenSSL, generate a PKCS10 CSR and populate any required CSR attributes
based on the response in step 8.
11. Invoke est_client_enroll_csr() to send the PKCS10 CSR to the CA and
receive the X509 certificate.
12. Invoke est_client_copy_enrolled_cert() to copy the X509 cert provided
by the EST server to local storage.
13. Invoke est_destroy() to remove the EST context.
The procedure outlined above describes the general use case for
provisioning a certificate. Please be aware the EST specification
allows for many variations. Other considerations include:
@latexonly
\begin{itemize}
\item Handling the retry-after response when the CA isn't configured
for automatic approval.
\item Manual verification of the CA server when trusted root
certificates are not pre-provisioned on the EST client.
\item Bootstrap use case where multiple trust anchors are used.
\item The re-enrollment process to renew a certificate.
\item Enable CRL checks when verifying the server identity.
\item Provide thread locking mechanism required by OpenSSL.
\end{itemize}
@endlatexonly
@section ESTServer EST Server Operation
The EST specification covers a broad spectrum of the OSI
model. EST places requirements on TLS, HTTP, and the certificate
authority (CA). libEST is not a CA. libEST only implements the
TLS and HTTP layers as defined in RFC 7030. It
is the responsibility of your application to bind
the CA server to libEST. Additionally, libEST does not implement
the TCP server required to accept incoming requests.
Your application must initialize and manage the
TCP sockets for incoming connections. Please reference EDCS-1265219
for a more detailed discussion on the architecture.
When implementing an EST server your application is
responsible for binding the EST stack to a CA. The
application is also responsible for opening the TCP sockets that will
receive incoming connections. An overview of implementing a server is:
@latexonly
\begin{itemize}
\item Initialize an EST context. The application provides the server
certificate and private key used to identify itself to any
EST clients. The application also provides the trusted certificate chain
to be used when responding to the /cacerts requests.
\item Specify the callback function that libEST will use to process
an incoming CSR from the client. This callback function is the
glue that binds libEST to the CA. This function will forward
the CSR to the CA and return the response to libEST. Your application
must implement this callback function.
\item Specify the callback function that libEST will invoke to verify
the client identity when HTTP basic or digest authentication
is used. This callback function would verify the user's identity
and return a response to libEST. A typical use case would be
to utilize a RADIUS server from within callback function. Your application
is responsible for hooking into the desired authentication server,
such as RADIUS, LDAP, OAuth, etc. libEST currently does not contain
support for authentication protocols. In the future libEST may
include built-in support for RADIUS, LDAP, etc.
\item Open one or more listening TCP sockets. These sockets must be
managed by the application. An example of doing this would be
to write an NGINX module that utlized NGINX to manage the
listening sockets, while forwarding incoming requests on these
sockets to libEST. Another example would be to write a custom
multi-threaded TCP server to accept incoming socket requests and
forward them to libEST.
\end{itemize}
@endlatexonly
The following API calls would be invoked to implement an EST server. These
represent the minimal configuration to implementing an EST server:
1. Invoke the est_apps_startup() helper function, which
initializes the OpenSSL library.
2. Invoke est_server_init() to attain a new EST context. The server's
certificate and private key are provided to this call.
3. Invoke est_set_ca_enroll_cb() to provide a callback function to
libEST that is invoked by libEST when a PKCS10 CSR needs to be
signed by the CA. Your application must implement this callback
function to forward the CSR to the CA.
4. Invoke est_set_csr_cb() to provide a callback function to
libEST that is invoked by libEST when requesting the CSR
attributes that should be included by EST clients during the
enrollment process.
5. Invoke est_server_start() to initialize the HTTPS services.
This step is required to setup the TLS context within the
HTTPS layer prior to receiving EST requests in step 7.
6. Open a TCP listening socket and wait for incoming requests.
7. Accept new incoming connections on the socket and invoke
est_server_handle_request().
The procedure outlined above describes the general use case for
implementing a simple EST server operating as either an RA or CA.
The EST specification allows for many
variations. libEST provides additional API entry points to customize
the behavior of the server. Other considerations include:
@latexonly
\begin{itemize}
\item Specify the retry period when the CA is configured for manual
approval.
\item Enable CRL checks when verifying the client identity.
\item Configuring either HTTP basic, HTTP digest, or no HTTP
authentication.
\item Disabling the proof-of-possession check.
\item Implementing a multi-threaded EST server to allow for simultaneous
processing of EST requests.
\item Providing support for the EST /simplereenroll flow.
\item Provide thread locking mechanism required by OpenSSL.
\item Enable TLS single-use DH key generation.
\end{itemize}
@endlatexonly
@section ESTProxy EST Proxy Operation
libEST provides the ability to operate as an EST proxy. An EST proxy receives
incoming EST requests and forwards outgoing EST requests to either an RA or CA.
A typical use case for EST proxy mode would be to deploy the proxy on a VPN
head-end device that is dual-homed on both a public and private network. This would
allow EST requests orginating from VPN clients on the public Internet to be
forwarded to an RA or CA residing on a private network.
Using libEST in proxy mode is similar to server mode operation. The application
is responsible for implementing the TCP listener and managing the TCP connections.
However, there is no need to integrate a CA with libEST when operating in
proxy mode, which makes proxy mode suitable for operating as an RA. The following
steps outline the minimal API calls required to implement an EST proxy:
1. Invoke the est_apps_startup() helper function, which
initializes the OpenSSL library.
2. Invoke est_proxy_init() to attain a new EST context. The proxy server
certificate and private key are provided to this call. This certificate is
used to identify the proxy to both the client and to the RA/CA.
3. Invoke est_proxy_set_server() to specify the IP address and port of the RA/CA.
4. Invoke est_proxy_start() to initialize the HTTPS services.
This step is required to setup the TLS context within the
HTTPS layer prior to receiving EST requests in step 6.
5. Open a TCP listening socket and wait for incoming requests.
6. Accept new incoming connections on the socket and invoke
est_server_handle_request().
*/