diff options
| author | william <william+macosx@25thandclement.com> | 2015-06-04 15:27:16 -0700 |
|---|---|---|
| committer | william <william+macosx@25thandclement.com> | 2015-06-04 15:27:16 -0700 |
| commit | c7edf769c899cab01d35dc97256a049f11d508ec (patch) | |
| tree | 829b96ed78c1bf04321b082dcb4466761701bbde | |
| parent | dc6063ab7dcc99462dcca0bcaa92a00dbf5c3fcb (diff) | |
| download | luaossl-c7edf769c899cab01d35dc97256a049f11d508ec.tar.gz luaossl-c7edf769c899cab01d35dc97256a049f11d508ec.tar.bz2 luaossl-c7edf769c899cab01d35dc97256a049f11d508ec.zip | |
update documentation for new extension APIs
| -rw-r--r-- | doc/luaossl.pdf | bin | 284785 -> 286521 bytes | |||
| -rw-r--r-- | doc/luaossl.tex | 43 |
2 files changed, 39 insertions, 4 deletions
diff --git a/doc/luaossl.pdf b/doc/luaossl.pdf index c2b2418..a253cff 100644 --- a/doc/luaossl.pdf +++ b/doc/luaossl.pdf | |||
| Binary files differ | |||
diff --git a/doc/luaossl.tex b/doc/luaossl.tex index b7b8c15..96a966c 100644 --- a/doc/luaossl.tex +++ b/doc/luaossl.tex | |||
| @@ -355,15 +355,38 @@ Returns a key-value iterator over the alternative names. The key is one of ``ema | |||
| 355 | 355 | ||
| 356 | Binds the X.509 extension OpenSSL object. | 356 | Binds the X.509 extension OpenSSL object. |
| 357 | 357 | ||
| 358 | \subsubsection[\fn{extension.new}]{\fn{extension.new($name$, $value$ [, $conf$])}} | 358 | \subsubsection[\fn{extension.new}]{\fn{extension.new($name$, $value$ [, $data$])}} |
| 359 | 359 | ||
| 360 | Returns a new X.509 extension. $name$, $value$, and $conf$ are [currently] plain text strings. | 360 | Returns a new X.509 extension. If $value$ is the string ``DER'' or ``critical,DER'', then $data$ is an ASN.1-encoded octet string. Otherwise, $name$ and $value$ are plain text strings in \href{https://www.openssl.org/docs/apps/x509v3_config.html#ARBITRARY_EXTENSIONS}{OpenSSL's arbitrary extension format}; and if specified, $data$ is an OpenSSL configuration string defining any referenced identifiers in $value$. |
| 361 | $value$ and $conf$ should use \href{https://www.openssl.org/docs/apps/x509v3_config.html#ARBITRARY_EXTENSIONS}{OpenSSL's arbitrary extension format}. | ||
| 362 | 361 | ||
| 363 | \subsubsection[\fn{extension.interpose}]{\fn{extension.interpose($name$, $function$)}} | 362 | \subsubsection[\fn{extension.interpose}]{\fn{extension.interpose($name$, $function$)}} |
| 364 | 363 | ||
| 365 | Add or interpose an extension class method. Returns the previous method, if any. | 364 | Add or interpose an extension class method. Returns the previous method, if any. |
| 366 | 365 | ||
| 366 | \subsubsection[\fn{extension:getID}]{\fn{extension:getID()}} | ||
| 367 | |||
| 368 | Returns the ASN.1 OID as a plain text string. | ||
| 369 | |||
| 370 | \subsubsection[\fn{extension:getName}]{\fn{extension:getName()}} | ||
| 371 | |||
| 372 | Returns a more human-readable name as a plain text string in the following order of preference: OpenSSL's short name, OpenSSL's long name, ASN.1 OID. | ||
| 373 | |||
| 374 | \subsubsection[\fn{extension:getShortName}]{\fn{extension:getShortName()}} | ||
| 375 | |||
| 376 | Returns OpenSSL's short name as a plain text string if available. | ||
| 377 | |||
| 378 | \subsubsection[\fn{extension:getLongName}]{\fn{extension:getLongName()}} | ||
| 379 | |||
| 380 | Returns OpenSSL's long name as a plain text string if available. | ||
| 381 | |||
| 382 | \subsubsection[\fn{extension:getData}]{\fn{extension:getData()}} | ||
| 383 | |||
| 384 | Returns the extension value as an ASN.1-encoded octet string. | ||
| 385 | |||
| 386 | \subsubsection[\fn{extension:getCritical}]{\fn{extension:getCritical()}} | ||
| 387 | |||
| 388 | Returns the extension critical flag as a boolean. | ||
| 389 | |||
| 367 | \end{Module} | 390 | \end{Module} |
| 368 | 391 | ||
| 369 | 392 | ||
| @@ -473,7 +496,11 @@ Sets the basic constraints critical flag. | |||
| 473 | 496 | ||
| 474 | \subsubsection[\fn{x509:addExtension}]{\fn{x509:addExtension($ext$)}} | 497 | \subsubsection[\fn{x509:addExtension}]{\fn{x509:addExtension($ext$)}} |
| 475 | 498 | ||
| 476 | Adds \module{x509.extension} object to the certificate. | 499 | Adds a copy of the \module{x509.extension} object to the certificate. |
| 500 | |||
| 501 | \subsubsection[\fn{x509:getExtension}]{\fn{x509:getExtension($name$)}} | ||
| 502 | |||
| 503 | Returns a copy of the \module{x509.extension} object identified by $name$, where $name$ is a plain text string of the OID, long name, or short name. Returns $nil$ if no such extension was found. | ||
| 477 | 504 | ||
| 478 | \subsubsection[\fn{x509:isIssuedBy}]{\fn{x509:isIssuedBy($issuer$)}} | 505 | \subsubsection[\fn{x509:isIssuedBy}]{\fn{x509:isIssuedBy($issuer$)}} |
| 479 | 506 | ||
| @@ -601,6 +628,14 @@ Sets the issuer distinguished name. $name$ should be an \module{x509.name} objec | |||
| 601 | 628 | ||
| 602 | Add the certificate identified by $serial$ to the revocation list. $serial$ should be a \module{openssl.bignum} object, as returned by \fn{x509:getSerial}. $time$ is the revocation date as a Unix timestamp. If unspecified $time$ defaults to the current time. | 629 | Add the certificate identified by $serial$ to the revocation list. $serial$ should be a \module{openssl.bignum} object, as returned by \fn{x509:getSerial}. $time$ is the revocation date as a Unix timestamp. If unspecified $time$ defaults to the current time. |
| 603 | 630 | ||
| 631 | \subsubsection[\fn{crl:addExtension}]{\fn{crl:addExtension($ext$)}} | ||
| 632 | |||
| 633 | Adds a copy of the \module{x509.extension} object to the revocation list. | ||
| 634 | |||
| 635 | \subsubsection[\fn{crl:getExtension}]{\fn{crl:getExtension($name$)}} | ||
| 636 | |||
| 637 | Returns a copy of the \module{x509.extension} object identified by $name$, where $name$ is a plain text string of the OID, long name, or short name. Returns $nil$ if no such extension was found. | ||
| 638 | |||
| 604 | \subsubsection[\fn{crl:sign}]{\fn{crl:sign($key$)}} | 639 | \subsubsection[\fn{crl:sign}]{\fn{crl:sign($key$)}} |
| 605 | 640 | ||
| 606 | Signs the instance CRL using the \module{openssl.pkey} $key$. | 641 | Signs the instance CRL using the \module{openssl.pkey} $key$. |
