Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
uncors - npm Package Compare versions
Comparing version 0.0.9 to 0.1.0
| { | ||
| "name": "uncors", | ||
| "version": "0.0.9", | ||
| "version": "0.1.0", | ||
| "description": "A simple dev HTTP/HTTPS reverse proxy for replacing CORS headers.", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
188
README.md
@@ -8,11 +8,11 @@ <!--suppress HtmlDeprecatedAttribute --> | ||
| <p align="center"> | ||
| A simple dev HTTP/HTTPS proxy for replacing CORS headers. | ||
| A simple dev HTTP/HTTPS proxy for replacing CORS headers. | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://go.dev"> | ||
| <img alt="Go version" src="https://img.shields.io/github/go-mod/go-version/evg4b/uncors"> | ||
| </a> | ||
| <a href="https://github.com/evg4b/uncors/releases/latest"> | ||
| <img alt="GitHub version" src="https://img.shields.io/github/v/tag/evg4b/uncors?label=version"> | ||
| </a> | ||
| <a href="https://go.dev"> | ||
| <img alt="Go version" src="https://img.shields.io/github/go-mod/go-version/evg4b/uncors"> | ||
| </a> | ||
| <a href="https://github.com/evg4b/uncors/releases/latest"> | ||
| <img alt="GitHub version" src="https://img.shields.io/github/v/tag/evg4b/uncors?label=version"> | ||
| </a> | ||
| <a href="https://github.com/evg4b/uncors/blob/main/LICENSE"> | ||
@@ -41,11 +41,13 @@ <img alt="License" src="https://img.shields.io/github/license/evg4b/uncors?label=license"> | ||
| - CORS header replacement | ||
| - HTTPS support | ||
| - Wildcard URL request mapping | ||
| - Simple request/response mocking | ||
| - HTTP/HTTPS proxy support | ||
| - *Static file serving ([coming soon...](./ROADMAP.md))* | ||
| - [Wildcard host mapping](https://github.com/evg4b/uncors/wiki/2.-Configuration#wilcard-mapping) | ||
| - [HTTPS support](https://github.com/evg4b/uncors/wiki/2.-Configuration#https-configuration) | ||
| - [Response mocking](https://github.com/evg4b/uncors/wiki/3.-Response-mocksing) | ||
| - [HTTP/HTTPS proxy support](https://github.com/evg4b/uncors/wiki/2.-Configuration#proxy-configuration) | ||
| - [Static file serving](https://github.com/evg4b/uncors/wiki/4.-Static-file-serving) | ||
| - *Response caching ([coming soon...](./ROADMAP.md))* | ||
| Other new features you can find in [UNCORS roadmap](https://github.com/evg4b/uncors/blob/main/ROADMAP.md) | ||
| Other new features you can find in [roadmap](https://github.com/evg4b/uncors/blob/main/ROADMAP.md). | ||
| Full documentation you can found on [wiki pages](https://github.com/evg4b/uncors/wiki). | ||
| # Quick Install | ||
@@ -87,2 +89,18 @@ | ||
| ## Docker | ||
| We currently offer images for [Docker](https://hub.docker.com/r/evg4b/uncors) | ||
| ```bash | ||
| docker run -p 80:3000 evg4b/uncors --from 'http://local.github.com' --to 'https://github.com' | ||
| ``` | ||
| ## Stew (Cross-platform) | ||
| Also, you can install binaris using [Stew](https://github.com/marwanhawari/) with the following commands: | ||
| ```bash | ||
| stew install evg4b/uncors | ||
| ``` | ||
| ## Binary (Cross-platform) | ||
@@ -97,10 +115,2 @@ | ||
| ## Docker | ||
| We currently offer images for [Docker](https://hub.docker.com/r/evg4b/uncors) | ||
| ```bash | ||
| docker run -p 80:3000 evg4b/uncors --from 'http://local.github.com' --to 'https://github.com' | ||
| ``` | ||
| ## Build from source | ||
@@ -130,138 +140,12 @@ | ||
| The following command can be used to start the Uncors proxy server: | ||
| The following command can be used to start the UNCORS proxy server: | ||
| ``` | ||
| uncors --http-port 8080 --to 'https://github.com' --from 'http://localhost' | ||
| uncors --from 'http://localhost' --to 'https://github.com' --http-port 8080 | ||
| ``` | ||
| ## CLI Parameters | ||
| More information about configuration and usage you can fiund on [UNCORS wiki](https://github.com/evg4b/uncors/wiki). | ||
| The following command-line parameters can be used to configure the Uncors proxy server: | ||
| # ⚠️ Caution | ||
| * `--from` - Specifies the local host with protocol for the resource from which proxying will take place. | ||
| * `--to` - Specifies the target host with protocol for the resource to be proxied. | ||
| * `--http-port` or `-p` - Specifies the local HTTP listening port. | ||
| * `--https-port` or `-s` - Specifies the local HTTPS listening port. | ||
| * `--cert-file` - Specifies the path to the HTTPS certificate file. | ||
| * `--key-file` - Specifies the path to the matching certificate private key. | ||
| * `--proxy` - Specifies the HTTP/HTTPS proxy to provide requests to the real server (system default is used by default). | ||
| * `--config` - Specifies the path to the [configuration file](#configuration-file). | ||
| * `--debug` - Enables debug output. | ||
| Any configuration parameters passed via CLI (except for `--from` and `--to`) will override the corresponding | ||
| parameters specified in the configuration file. The `--from` and `--to` parameters will add an additional mapping | ||
| to the configuration. | ||
| ## Configuration file | ||
| Uncors supports a YAML file configuration with the following options: | ||
| ```yaml | ||
| # Base configuration | ||
| http-port: 8080 # Local HTTP listened port. | ||
| mappings: | ||
| http://localhost:3000: https://githib.com | ||
| debug: false # Show debug output. | ||
| proxy: localhost:8080 | ||
| # HTTPS configuration | ||
| https-port: 8081 # Local HTTPS listened port. | ||
| cert-file: ~/server.crt # Path to HTTPS certificate file. | ||
| key-file: ~/server.key # Path to matching for certificate private key. | ||
| # Mock definitions are used to generate fake responses for certain endpoints. | ||
| mocks: | ||
| - path: /hello-word | ||
| response: | ||
| code: 200 | ||
| raw-content: 'Hello word' | ||
| ``` | ||
| #### Mocks configuration | ||
| The mocks configuration section in Uncors allows you to define specific endpoints to be mocked, including the response | ||
| data and other parameters. Currently, mocks are defined globally for all mappings. Available path, method, queries, and headers filters, | ||
| which utilize the [gorilla/mux route matching system](https://github.com/gorilla/mux#matching-routes). | ||
| Each endpoint mock requires a path parameter, which defines the URL path for the endpoint. You can also use the method | ||
| parameter to define a specific HTTP method for the endpoint. | ||
| The queries and headers parameters can be used to specify more detailed URLs that will be mocked. The queries parameter | ||
| allows you to define specific query parameters for the URL, while the headers parameter allows you to define specific | ||
| HTTP headers. | ||
| Here is the structure of the mock configuration: | ||
| ```yaml | ||
| mocks: | ||
| - path: <string> | ||
| method: <string> | ||
| queries: | ||
| <string>: <string> | ||
| # ... | ||
| headers: | ||
| <string>: <string> | ||
| # ... | ||
| response: | ||
| code: <int> | ||
| headers: | ||
| <string>: <string> | ||
| # ... | ||
| delay: <string> | ||
| raw-content: <string> | ||
| file: <string> | ||
| ``` | ||
| - `path` (required) - This property is used to define the URL path that should be mocked. The value should be a string, | ||
| such as `/example`. The path can include variables, such as `/users/{id}`, which will match any URL that starts | ||
| with `/users/` and has a variable `id` in it. | ||
| - `method` (optional) - This property is used to define the HTTP method that should be mocked. | ||
| The value should be a string. If this property is not specified, the mock will match any HTTP method. | ||
| - `queries` (optional) - This property is used to define specific query parameters that should be matched against the | ||
| request URL. The value should be a mapping of query parameters and their values, such as `{"param1": "value1", " | ||
| param2": "value2"}`. If this property is not specified, the mock will match any query parameter. | ||
| - `headers` (optional): This property is used to define specific HTTP headers that should be matched against the request | ||
| headers. The value should be a mapping of header names and their values, such as `{"Content-Type": "application/json"}`. | ||
| If this property is not specified, the mock will match any HTTP header. | ||
| - `response` (required): This property is used to define the mock response. It should be a mapping that contains the | ||
| following properties: | ||
| - `code` (optional): This property is used to define the HTTP status code that should be returned in the mock | ||
| response. The value should be an integer, such as 200 or 404. If this property is not specified, the mock will use | ||
| 200 OK status code. | ||
| - `headers` (optional): This property is used to define specific HTTP headers that should be returned in the mock | ||
| response. The value should be a mapping of header names and their values, such as `{"Content-Type": " | ||
| application/json"}`. If this property is not specified, the mock response will have no extra headers. | ||
| - `delay` (optional): This property is used to define a delay before sending the mock response. The value should be a | ||
| string in the format `<number><unit> <nunmber><units> ...`, where `<number>` is a positive integer and `<unit>` is time units. | ||
| Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. For example, `1m 30s` would delay the response by 1 minute and 30 | ||
| seconds. If this property is not specified, the mock response will be sent immediately. | ||
| - `raw-content` (optional): This property is used to define the raw content that should be returned in the mock | ||
| response. The value should be a string, such as `Hello, world!`. If this property is not specified, the mock | ||
| response will be empty. | ||
| - `file` (optional): This property is used to define the path to a file that contains the mock response content. The | ||
| file content will be used as the response content. The value should be a string that specifies the file path, such | ||
| as `~/mocks/example.json`. If this property is not specified, the mock response will be empty. | ||
| ## How it works | ||
| ```mermaid | ||
| sequenceDiagram | ||
| participant Client | ||
| participant Uncors | ||
| participant Server | ||
| alt Handling OPTIONS queries | ||
| Client ->> Uncors: Access-Control-Request | ||
| Uncors ->> Client: Allow-Control-Request | ||
| end | ||
| alt Handling Data queries | ||
| Client ->> Uncors: GET, POST, PUT... query | ||
| Note over Uncors: Replacing url with target<br/> in headers and cookies | ||
| Uncors-->>Server: Real GET, POST, PUT... query | ||
| Server->>Uncors: Real response | ||
| Note over Uncors: Replacing url with source<br/> in headers and cookies | ||
| Uncors-->>Client: Data response | ||
| end | ||
| ``` | ||
| Please note that removing or replacing CORS headers can pose potential security vulnerabilities. This tool is specifically designed to streamline the development and testing workflow and should not be used in a production environment or as a remote proxy server. It has not undergone a thorough security review, so caution should be exercised when utilizing it. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-42.63%
7317
- Number of lines in readme file
- decreased by-44.11%
147
No dependency changes