From 54db93c53090747f41cf0a78f8bcebb3e7daba4f Mon Sep 17 00:00:00 2001 From: Bart van Strien Date: Thu, 4 Jun 2015 13:01:32 +0200 Subject: [PATCH] Create list of functions and methods to be documented --- doc/cert.md | 19 +++++++++++++++++++ doc/context.md | 20 ++++++++++++++++++++ doc/core.md | 9 +++++++++ doc/luasec.md | 13 +++++++++++++ doc/ssl.md | 22 ++++++++++++++++++++++ 5 files changed, 83 insertions(+) create mode 100644 doc/cert.md create mode 100644 doc/context.md create mode 100644 doc/core.md create mode 100644 doc/luasec.md create mode 100644 doc/ssl.md diff --git a/doc/cert.md b/doc/cert.md new file mode 100644 index 0000000..f276171 --- /dev/null +++ b/doc/cert.md @@ -0,0 +1,19 @@ +Functions +--------- + +`cert.load` + +Methods +------- + +`cert:digest` +`cert:setencode` +`cert:extensions` +`cert:issuer` +`cert:notbefore` +`cert:notafter` +`cert:pem` +`cert:pubkey` +`cert:serial` +`cert:subject` +`cert:validat` diff --git a/doc/context.md b/doc/context.md new file mode 100644 index 0000000..7aa9563 --- /dev/null +++ b/doc/context.md @@ -0,0 +1,20 @@ +Functions +--------- + +`context.create` +`context.locations` +`context.loadcert` +`context.loadkey` +`context.checkkey` +`context.setcipher` +`context.setdepth` +`context.setdhparam` +`context.setcurve` +`context.setverify` +`context.setoptions` +`context.setmode` + +Methods +------- + +`context:setverifyext` diff --git a/doc/core.md b/doc/core.md new file mode 100644 index 0000000..efdbe08 --- /dev/null +++ b/doc/core.md @@ -0,0 +1,9 @@ +Functions +--------- + +`ssl.compression` +`ssl.create` +`ssl.info` +`ssl.setfd` +`ssl.setmethod` +`ssl.copyright` diff --git a/doc/luasec.md b/doc/luasec.md new file mode 100644 index 0000000..f9d45b0 --- /dev/null +++ b/doc/luasec.md @@ -0,0 +1,13 @@ +LuaSec +====== + +LuaSec is a binding for OpenSSL library to provide TLS/SSL communication. It +takes an already established TCP connection and creates a secure session +between the peers. + +Functions +--------- + +`ssl.loadcertificate` +`ssl.newcontext` +`ssl.wrap` diff --git a/doc/ssl.md b/doc/ssl.md new file mode 100644 index 0000000..c450dfd --- /dev/null +++ b/doc/ssl.md @@ -0,0 +1,22 @@ +Created using `ssl.create` or `ssl.wrap`. + +Methods +---------------------- + +`conn:close` +`conn:getfd` +`conn:getfinished` +`conn:getpeercertificate` +`conn:getpeerchain` +`conn:getpeerverification` +`conn:getpeerfinished` +`conn:getsniname` +`conn:getstats` +`conn:setstats` +`conn:dirty` +`conn:dohandshake` +`conn:receive` +`conn:send` +`conn:settimeout` +`conn:sni` +`conn:want`