https://github.com/59naga/socket.io-middleware-firebase-admin
a socket.io middleware firebaseAdmin.verifySessionCookie
https://github.com/59naga/socket.io-middleware-firebase-admin
middleware socketio-server
Last synced: 7 months ago
JSON representation
a socket.io middleware firebaseAdmin.verifySessionCookie
- Host: GitHub
- URL: https://github.com/59naga/socket.io-middleware-firebase-admin
- Owner: 59naga
- Created: 2018-08-15T17:30:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-19T05:27:07.000Z (over 7 years ago)
- Last Synced: 2025-07-26T19:36:38.072Z (9 months ago)
- Topics: middleware, socketio-server
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Socket.io Middleware firebase-admin
---
a socket.io middleware [firebaseAdmin.verifySessionCookie](https://firebase.google.com/docs/auth/admin/manage-cookies)
Installation
---
```
yarn add socket.io-middleware-firebase-admin
```
API
---
## createIoMiddlewareFirebaseAdmin(app, options = {}): middleware
```js
import { createServer } from "http";
import createIoServer from "socket.io";
import createIoClient from "socket.io-client";
import createIoMiddlewareFirebaseAdmin from "socket.io-middleware-firebase-admin";
import credential from "./.credential";
const server = createServer();
const io = createIoServer(server);
const app = firebaseAdmin.initializeApp({
credential: firebaseAdmin.credential.cert(credential)
});
const ioMiddleware = createIoMiddlewareFirebaseAdmin(app);
io.use(ioMiddleware);
server.listen(() => {
const { port } = server.address();
const client = createIoClient(`http://localhost:${port}`, {
query: {
session: ""//await firebaseAdmin.auth().createSessionCookie(idToken)
}
});
client.on("connect", error => {
const decodedClaims = ioMiddleware.getCache(client);
console.log(decodedClaims);
});
});
```
### `options`
* `options.deny`= true: boolean
Deny connections of users who couldn't authenticate.
* `options.cache`= true: boolean
Cache claim of authenticated user.
## ioMiddleware.getCache(client): decodedClaims
Returns the claim of the authenticated user.
```js
console.log(ioMiddleware.getCache(client));
// { iss:
// 'https://session.firebase.google.com/socketio-middleware-demo1',
// aud: 'socketio-middleware-demo1',
// auth_time: 1534417139,
// user_id: 'CUCPCuD50xgKeEfVggJ1fYQYNOj1',
// sub: 'CUCPCuD50xgKeEfVggJ1fYQYNOj1',
// iat: 1534417140,
// exp: 1534417440,
// email: 'i59naga@icloud.com',
// email_verified: false,
// firebase:
// { identities: { email: [Array] }, sign_in_provider: 'custom' }
```
License
---
MIT