chore(tls): add tls support documentation

Author: LeoBorai

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 <Empty>
 
+<a name="v0.2.0"></a>
+## v0.2.0 (2021-04-19)
+
+> Requires Rust: rustc 1.49.0 (e1884a8e3 2020-12-29)
+
+#### Features
+
+* Add support for HTTPS serving using TLS
+  * Support TLS certificates
+  * Support TLS keys using RSA or PKCS8 algorithm
+
+#### Improvements
+
+* Refactor CLI implementation to use _structopt_
+
 <a name="v0.1.0"></a>
 ## v0.1.0 (2021-04-02)
 

README.md

@@ -33,7 +33,7 @@ http-server --help
 ## Usage
 
 ```
-http-server [FLAGS] [OPTIONS] [root_dir]
+http-server [FLAGS] [OPTIONS] [root-dir]
 ```
 
 ### Flags
@@ -64,9 +64,9 @@ Host | `-h` | `--host` | Address to bind the server | `127.0.0.1`
 Port | `-p` | `--port` | Port to bind the server | `7878`
 Configuration File | `-c` | `--config` | Specifies a configuration file. [Example](https://github.com/EstebanBorai/http-server/blob/main/fixtures/config.toml) | N/A
 TLS | N/A | `--tls` | Enable TLS for HTTPS connections. Requires a Certificate and Key. [Reference](#tls-reference) | N/A
-TLS Ceritificate | N/A | `--tls_cert` | Path to TLS certificate file. **Depends on `--tls`** | `cert.pem`
-TLS Key | N/A | `--tls_key` | Path to TLS key file. **Depends on `--tls`** | `key.rsa`
-TLS Key Algorithm | N/A | `--tls_key_alg` | Algorithm used to generate certificate key. **Depends on `--tls`** | `rsa`
+TLS Ceritificate | N/A | `--tls-cert` | Path to TLS certificate file. **Depends on `--tls`** | `cert.pem`
+TLS Key | N/A | `--tls-key` | Path to TLS key file. **Depends on `--tls`** | `key.rsa`
+TLS Key Algorithm | N/A | `--tls-key-algorithm` | Algorithm used to generate certificate key. **Depends on `--tls`** | `rsa`
 
 ## References
 
@@ -89,7 +89,7 @@ This script relies on `openssl`, so make sure you have it installed in your syst
 Run `http-server` as follows:
 
 ```sh
-http-server --tls --tls_cert <PATH TO YOUR CERTIFICATE> --tls_key <PATH TO YOUR KEY> --tls_key_alg pkcs8
+http-server --tls --tls-cert <PATH TO YOUR CERTIFICATE> --tls-key <PATH TO YOUR KEY> --tls-key-algorithm pkcs8
 ```
 
 ## Release

src/cli.rs

@@ -12,7 +12,6 @@ use crate::config::util::tls::PrivateKeyAlgorithm;
 )]
 pub struct Cli {
     /// Path to TOML configuration file.
-    /// https://github.com/EstebanBorai/http-server/blob/main/fixtures/config.toml
     #[structopt(parse(from_os_str), short = "c", long = "config")]
     pub config: Option<PathBuf>,
     /// Host (IP) to bind the server
@@ -27,18 +26,16 @@ pub struct Cli {
     /// Turns on stdout/stderr logging
     #[structopt(short = "v", long = "verbose")]
     pub verbose: bool,
-    /// Enables HTTPS serving using TLS. Requires a Certificate and a Key
-    /// provided with the `tls_cert` and `tls_key` options
+    /// Enables HTTPS serving using TLS
     #[structopt(long = "tls")]
     pub tls: bool,
     /// Path to the TLS Certificate
-    #[structopt(long = "tls_cert", parse(from_os_str), default_value = "cert.pem")]
+    #[structopt(long = "tls-cert", parse(from_os_str), default_value = "cert.pem")]
     pub tls_cert: PathBuf,
     /// Path to the TLS Key
-    #[structopt(long = "tls_key", parse(from_os_str), default_value = "key.rsa")]
+    #[structopt(long = "tls-key", parse(from_os_str), default_value = "key.rsa")]
     pub tls_key: PathBuf,
-    /// Algorithm used to generate certificate key. Supports RSA (rsa) and
-    /// PKCS8 (pkcs8)
-    #[structopt(long = "tls_key_algorithm", default_value = "rsa")]
+    /// Algorithm used to generate certificate key
+    #[structopt(long = "tls-key-algorithm", default_value = "rsa")]
     pub tls_key_algorithm: PrivateKeyAlgorithm,
 }