`\r\n\tctx.body += JSON.stringify(principal, null, 2);\r\n\tctx.body += ''\r\n}).listen(80);\r\n```\r\nUnder the traditional pattern, cas client NEED to use with session, especially those 'Spring mvc' project in servlet.\r\n\r\nSo there is also a way to implement with all nodejs backend frameworks. For example in Koa2,\r\n```js\r\nconst koaSessionCasClient = require('http-cas-client/wrap/koa2-session');\r\nconst session = require('koa-session');\r\nconst Koa = require('koa');\r\nconst casServerUrlPrefix = 'http://localhost:9000/cas';\r\n\r\nconst app = new Koa();\r\nconst sessionMiddleware = session(app);\r\napp.keys = ['koa-app'];\r\n\r\napp.use(session(app)).use(koaSessionCasClient({\r\n\tcasServerUrlPrefix: 'http://localhost:9000/cas',\r\n\tserverName: 'http://127.0.0.1'\r\n})).use(ctx => {\r\n\tconst { principal } = ctx;\r\n\r\n\t// your statements...\r\n\tctx.body = `SLO
`\r\n\tctx.body += JSON.stringify(principal, null, 2);\r\n\tctx.body += ''\r\n}).listen(80);\r\n```\r\n### CAS Proxy (Use ServiceTicket instance)\r\n```js\r\nconst koaSessionCasClient = require('http-cas-client/wrap/koa2-session');\r\nconst koaCasClient = require('http-cas-client/wrap/koa2');\r\nconst Koa = require('koa');\r\nconst session = require('koa-session');\r\n\r\nconst casServerUrlPrefix = 'http://localhost:9000/cas';\r\n\r\nconst app = new Koa();\r\napp.keys = ['koa-app'];\r\napp.use(session(app)).use(koaSessionCasClient({\r\n\tcasServerUrlPrefix: 'http://localhost:9000/cas',\r\n\tserverName: 'http://127.0.0.1:2000',\r\n\tclient: {\r\n\t\tproxy: {\r\n\t\t\tcallbackUrl: 'http://127.0.0.1:2000/callback',\r\n\t\t\treceptorUrl: '/callback'\r\n\t\t}\r\n\t}\r\n})).use((ctx, next) => {\r\n\t// If req.url matches /app, skip into next middleware.\r\n\tif (ctx.request.path === '/app') {\r\n\t\treturn next();\r\n\t}\r\n\r\n\tconst { principal } = ctx;\r\n\r\n\t// This is the 1st cas client.\r\n\t// your statements...\r\n\tctx.body = `
This is proxy
`;\r\n\tctx.body = `SLO`\r\n\tctx.body += JSON.stringify(principal, null, 2);\r\n\tctx.body += ''\r\n}).use(async ctx => {\r\n\tconst { ticket } = ctx;\r\n\r\n\t// Proxy request some data from 2rd cas client 'http://127.0.0.1:3000'.\r\n\tconst response = await ticket.request('http://127.0.0.1:3000/').then(axios => {\r\n\t\treturn axios.post('/test');\r\n\t});\r\n\r\n\t// Proxy send the data from 2rd.\r\n\tctx.body = response.data;\r\n}).listen(2000);\r\n\r\nconst app2 = new Koa();\r\napp2.use(koaCasClient({\r\n\tcasServerUrlPrefix: 'http://localhost:9000/cas',\r\n\tserverName: 'http://127.0.0.1:3000',\r\n\tclient: {\r\n\t\tproxy: {\r\n\t\t\tacceptAny: true,\r\n\t\t\tcallbackUrl: 'http://127.0.0.1:3000/proxyCallback',\r\n\t\t\treceptorUrl: '/proxyCallback'\r\n\t\t}\r\n\t}\r\n})).use(async ctx => {\r\n\t//This is the 2nd cas client.\r\n\tconst { principal, ticket } = ctx;\r\n\r\n\t// Proxy request some data from 3rd cas client 'http://127.0.0.1:4000/'.\r\n\tconst response = await ticket.request('http://127.0.0.1:4000/').then(axios => {\r\n\t\treturn axios.post('/test');\r\n\t});\r\n\r\n\t// your statements...\r\n\tctx.body = `
This is App
`;\r\n\tctx.body += `SLO`;\r\n\tctx.body += JSON.stringify(principal, null, 2);\r\n\tctx.body += '';\r\n\r\n\t// Combine data from the 3rd.\r\n\tctx.body += response.data;\r\n}).listen(3000);\r\n\r\nconst app3 = new Koa();\r\napp3.use(koaCasClient({\r\n\tcasServerUrlPrefix: 'http://localhost:9000/cas',\r\n\tserverName: 'http://127.0.0.1:4000',\r\n\tclient: {\r\n\t\tproxy: {\r\n\t\t\tacceptAny: true,\r\n\t\t}\r\n\t}\r\n})).use(async ctx => {\r\n\t// This is the 3rd cas client.\r\n\t// your statements...\r\n\tctx.body = 'from the proxy proxy app.'\r\n}).listen(4000);\r\n```\r\n### Custom Wrap\r\n//TODO But you can review 'http-cas-client/wrap/koa2.js'. Maybe you can understand how to do.\r\n\r\nAt least I think that's easy. Good luck.\r\n\r\n## API Referrence\r\n### Options\r\nThe origin of CAS Server is essential. The simplest form is like,\r\n```js\r\nconst httpCasClient = require('http-cas-client');\r\nconst handler = httpCasClient({\r\n\tcasServerUrlPrefix: 'http://localhost:9000/cas',\r\n\tserverName: 'http://127.0.0.1',\r\n});\r\n```\r\n#### Full Default Options\r\n```js\r\n// Other items are optional.\r\nconst defaultOptions = {\r\n\tcas: 3, // CAS protocol version 1, 2, 3\r\n\r\n\tclient: {\r\n\t\tservice: null,\r\n\t\tslo: true, // Use SLO?\r\n\t\trenew: false, // CAS renew.\r\n\t\tgateway: false, // CAS gateway\r\n\t\tuseSession: false,\r\n\t\tmethod: 'GET',\r\n\t\t// The resource path rules let cas client ignore.\r\n\t\tignore: [/\\.(ico|css|js|jpe?g|svg|png)/],\r\n\t\tproxy: {\r\n\t\t\tacceptAny: false,\r\n\t\t\tallowedChains: () => true,\r\n\t\t\tcallbackUrl: null,\r\n\t\t\treceptorUrl: null\r\n\t\t}\r\n\t},\r\n\r\n\tserver: {\r\n\t\tloginUrl: null,\r\n\r\n\t\t// CAS Server URIs. Normally no change is required.\r\n\t\t// Useful when use a nonstandard cas server or url re-writed.\r\n\t\tpath: {\r\n\t\t\tlogin: '/login',\r\n\t\t\tlogout: '/logout',\r\n\t\t\tvalidate: '/validate',\r\n\t\t\tserviceValidate: '/serviceValidate',\r\n\t\t\tproxyValidate: '/proxyValidate',\r\n\t\t\tproxy: '/proxy',\r\n\t\t\tp3: {\r\n\t\t\t\tserviceValidate: '/p3/serviceValidate',\r\n\t\t\t\tproxyValidate: '/p3/proxyValidate',\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n}\r\n```\r\nWhy these paths? See also, [CAS Protocol 3.0 Specification](https://apereo.github.io/cas/5.2.x/protocol/CAS-Protocol-Specification.html#2-cas-uris).\r\n\r\n#### Customs Options for Special Purposes\r\nYou can also override all items of options for your special cas server. And use chained multiple options arguments to create handler,\r\n```js\r\nconst casClientHandler = httpCasClient(options1, options2, ...);\r\n```\r\n### Store\r\nStore is an event emitter.\r\n#### Method\r\n\r\n//TODO\r\n\r\n#### Event\r\n//TODO\r\n\r\n## CAS Client Cluster\r\n### Shared Ticket Store\r\n### Sync ST store\r\n#### In Frontend\r\n#### In Backend\r\n\r\n## Debug\r\nBecause CAS protocol is complicated, we remove this option. We recommend you to always log every step that what CAS client do on your production environment.\r\n\r\nSetting env.DEBUG=\"cas,cas:*\";\r\n\r\n## License\r\n\r\nMIT","readmeFilename":"README.md","author":{"name":"ChaosLee"}}