Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddywashere/proxy-keystone
A proxy for OpenStack Keystone service catalog endpoints built on top of http-proxy.
https://github.com/eddywashere/proxy-keystone
Last synced: 25 days ago
JSON representation
A proxy for OpenStack Keystone service catalog endpoints built on top of http-proxy.
- Host: GitHub
- URL: https://github.com/eddywashere/proxy-keystone
- Owner: eddywashere
- License: mit
- Created: 2014-05-11T04:57:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-06-10T22:49:11.000Z (over 10 years ago)
- Last Synced: 2024-08-09T10:53:26.254Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 230 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Proxy-Keystone
A proxy for OpenStack Keystone service catalog endpoints built on top of http-proxy.
## Installation
```sh
npm install proxy-keystone
```
## [Example](https://passport-keystone-proxy.herokuapp.com/)
Check out the [live demo](https://passport-keystone-proxy.herokuapp.com/), source code [here](https://github.com/eddywashere/passport-keystone/tree/master/examples), to see an express app configured for authentication with the [Rackspace Cloud Identity Service](http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/QuickStart-000.html) and [Passport-Keystone](https://github.com/eddywashere/passport-keystone).
## Documentation
```javascript
var express = require('express');
var app = express();
var ProxyKeystone = require('proxy-keystone');
var proxyKeystone = new ProxyKeystone();
// proxy-keystone requires you to bring your own authentication middleware
// it should set req.user with a token and service catalog
app.use(function(req, res, next) {
req.user = {
token: '12345678910',
serviceCatalog:[{
name:"swift",
endpoints:[{
"region":"RegionOne",
"internalURL":"http://127.0.0.1:8080/v1/AUTH_1",
"publicURL":"http://swift.publicinternets.com/v1/AUTH_1"
}]
}]
};
next();
});
app.all('/proxy/*', proxyKeystone.middleware);
var server = app.listen(3000, function() {
console.log('Listening on port %d', server.address().port);
});
```
### Custom Usage
Sometimes the `req` object is organized differently. The `options.token` and `options.catalog` values are used to read keys off the request object. In the following example the user identity is located at `req.current_user` and a custom user agent is supplied.
```javascript
// example middleware to set user on req object
app.use(function(req, res, next) {
req.current_user = {
key: '12345678910',
catalog:[{
name:"swift",
endpoints:[{
"region":"RegionOne",
"internalURL":"http://127.0.0.1:8080/v1/AUTH_1",
"publicURL":"http://swift.publicinternets.com/v1/AUTH_1"
}]
}]
};
next();
});
var ProxyKeystone = require('proxy-keystone');
var proxyKeystone = new ProxyKeystone({
token: 'current_user.key', // req.current_user.key
catalog: 'current_user.catalog', // req.current_user.catalog
userAgent: 'Custom Openstack Dashboard' // forwarded in proxy headers
});
app.all('/proxy/*', proxyKeystone.middleware);
```
### Listening for proxy events
- `proxyStart` - This event is emitted when the proxy starts.
- `proxyEnd` - This event is emitted if the request to the target completed.
- `proxyError` - The error event is emitted if the request to the target fail.
```js
proxyKeystone.on('proxyStart',function(req, res, target){
console.log(req.url);
});
proxyKeystone.on('proxyEnd',function(req, res, proxyRes){
console.log('RAW Response from the target', JSON.stringify(proxyRes.headers, true, 2));
});
proxyKeystone.on('proxyError',function(err){
console.log(err.message);
});
```