Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isomorphic-git/cors-proxy
Proxy clone and push requests for the browser
https://github.com/isomorphic-git/cors-proxy
Last synced: 4 months ago
JSON representation
Proxy clone and push requests for the browser
- Host: GitHub
- URL: https://github.com/isomorphic-git/cors-proxy
- Owner: isomorphic-git
- License: mit
- Fork: true (billiegoose/cors-buster)
- Created: 2018-07-05T15:55:37.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T16:12:17.000Z (about 1 year ago)
- Last Synced: 2024-04-25T23:21:32.409Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 149 KB
- Stars: 87
- Watchers: 5
- Forks: 33
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @isomorphic-git/cors-proxy
This is the software running on https://cors.isomorphic-git.org/ -
a free service (generously sponsored by [Clever Cloud](https://www.clever-cloud.com/?utm_source=ref&utm_medium=link&utm_campaign=isomorphic-git))
for users of [isomorphic-git](https://isomorphic-git.org) that enables cloning and pushing repos in the browser.
It is derived from https://github.com/wmhilton/cors-buster with added restrictions to reduce the opportunity to abuse the proxy.
Namely, it blocks requests that don't look like valid git requests.
## Installation
```sh
npm install @isomorphic-git/cors-proxy
```
## CLI usage
Start proxy on default port 9999:
```sh
cors-proxy start
```
Start proxy on a custom port:
```sh
cors-proxy start -p 9889
```
Start proxy in daemon mode. It will write the PID of the daemon process to `$PWD/cors-proxy.pid`:
```sh
cors-proxy start -d
```
Kill the process with the PID specified in `$PWD/cors-proxy.pid`:
```sh
cors-proxy stop
```
### CLI configuration
Environment variables:
- `PORT` the port to listen to (if run with `npm start`)
- `ALLOW_ORIGIN` the value for the 'Access-Control-Allow-Origin' CORS header
- `INSECURE_HTTP_ORIGINS` comma separated list of origins for which HTTP should be used instead of HTTPS (added to make developing against locally running git servers easier)
## Middleware usage
You can also use the `cors-proxy` as a middleware in your own server.
```js
const express = require('express')
const corsProxy = require('@isomorphic-git/cors-proxy/middleware.js')
const app = express()
const options = {}
app.use(corsProxy(options))
```
### Middleware configuration
*The middleware doesn't use the environment variables.* The options object supports the following properties:
- `origin`: _string_. The value for the 'Access-Control-Allow-Origin' CORS header
- `insecure_origins`: _string[]_. Array of origins for which HTTP should be used instead of HTTPS (added to make developing against locally running git servers easier)
- `authorization`: _(req, res, next) => void_. A middleware function you can use to handle custom authorization. Is run after filtering for git-like requests and handling CORS but before the request is proxied.
_Example:_
```ts
app.use(
corsProxy({
authorization: (req: Request, res: Response, next: NextFunction) => {
// proxied git HTTP requests already use the Authorization header for git credentials,
// so their [Company] credentials are inserted in the X-Authorization header instead.
if (getAuthorizedUser(req, 'X-Authorization')) {
return next();
} else {
return res.status(401).send("Unable to authenticate you with [Company]'s git proxy");
}
},
})
);
// Only requests with a valid JSON Web Token will be proxied
function getAuthorizedUser(req: Request, header: string = 'Authorization') {
const Authorization = req.get(header);
if (Authorization) {
const token = Authorization.replace('Bearer ', '');
try {
const verifiedToken = verify(token, env.APP_SECRET) as IToken;
if (verifiedToken) {
return {
id: verifiedToken.userId,
};
}
} catch (e) {
// noop
}
}
}
```
## Installation on Kubernetes
There is no official chart for this project, helm or otherwise. You can make your own, but keep in mind cors-proxy uses the Micro server, which will return a 403 error for any requests that do not have the user agent header.
_Example:_
```yaml
containers:
- name: cors-proxy
image: node:lts-alpine
env:
- name: ALLOW_ORIGIN
value: https://mydomain.com
command:
- npx
args:
- '@isomorphic-git/cors-proxy'
- start
ports:
- containerPort: 9999
hostPort: 9999
name: proxy
protocol: TCP
livenessProbe:
tcpSocket:
port: proxy
readinessProbe:
tcpSocket:
port: proxy
```
## License
This work is released under [The MIT License](https://opensource.org/licenses/MIT)