summaryrefslogtreecommitdiff
path: root/docs/common/lib_server/TLSContext.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/common/lib_server/TLSContext.txt')
-rw-r--r--docs/common/lib_server/TLSContext.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/common/lib_server/TLSContext.txt b/docs/common/lib_server/TLSContext.txt
new file mode 100644
index 00000000..ff50d3e6
--- /dev/null
+++ b/docs/common/lib_server/TLSContext.txt
@@ -0,0 +1,16 @@
+CLASS TLSContext
+
+A wrapper over the OpenSSL context object.
+
+Note: you need to call SSLLib::Initialise at the beginning of your program to use these functions.
+
+
+SUBTITLE Construction
+
+The constuctor takes the following parameters
+
+* Boolean for whether this is acting as a server or a client
+* The .pem file containing the certificate which will be used
+* The .pem file containing the private key for this certificate
+* The .pem file containing the certificates which will certify the other end of the connection.
+