diff --git a/README.md b/README.md index a71d71f..0b097ae 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ # racket-self-signed-cert -Create self signed certificates based on the standard openssl libraries deployed with racket. \ No newline at end of file +Generate self signed certificates based on the standard openssl libraries deployed with racket. \ No newline at end of file diff --git a/scribblings/self-signed-cert.scrbl b/scribblings/self-signed-cert.scrbl index 980fa1d..e6a7676 100644 --- a/scribblings/self-signed-cert.scrbl +++ b/scribblings/self-signed-cert.scrbl @@ -16,7 +16,7 @@ together with a corresponding private key. The implementation uses the @racketmodname[openssl] bindings that are distributed with Racket. In other words, the module relies on the -OpenSSL library that ships with Racket and accesses it via Racket’s +OpenSSL library that ships with Racket and accesses it via Racket's FFI interface. The generated certificate and key are returned in PEM format and can @@ -33,7 +33,7 @@ During initialization the module performs the following steps: @itemlist[ @item{ It detects the major version of the OpenSSL library available through -Racket’s @racketmodname[openssl] bindings. +Racket's @racketmodname[openssl] bindings. } @item{ @@ -127,7 +127,7 @@ term “X.509 certificate”. Generates a new self-signed RSA certificate and private key. The implementation uses the OpenSSL functionality provided through -Racket’s @racketmodname[openssl] library. +Racket's @racketmodname[openssl] library. @subsection{Arguments} @@ -139,17 +139,17 @@ Racket’s @racketmodname[openssl] library. certificate remains valid.} @item{@racket[hosts] — a host name, IP address, or a list of such -values. These values are written into the certificate’s +values. These values are written into the certificate's @italic{Subject Alternative Name} extension.} -@item{@racket[country] — value for the certificate subject’s +@item{@racket[country] — value for the certificate subject's @tt{C} (country) attribute.} -@item{@racket[company] — value for the certificate subject’s +@item{@racket[company] — value for the certificate subject's @tt{O} (organization) attribute.} ] -The first host in the list is used as the certificate’s +The first host in the list is used as the certificate's Common Name (CN). @subsection{Result} @@ -171,7 +171,7 @@ Both values are returned as PEM encoded strings. (generate-self-signed-cert 2048 365 - '("localhost" "127.0.0.1") + '("localhost" "127.0.0.1" "*.local.lan") "NL" "Example Company"))