oidc_server.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. import {addGroupsWithAttributes, addEmail, changeFullname, changeUsername} from './loginHandler';
  2. Oidc = {};
  3. httpCa = false;
  4. if (process.env.OAUTH2_CA_CERT !== undefined) {
  5. try {
  6. const fs = Npm.require('fs');
  7. if (fs.existsSync(process.env.OAUTH2_CA_CERT)) {
  8. httpCa = fs.readFileSync(process.env.OAUTH2_CA_CERT);
  9. }
  10. } catch(e) {
  11. console.log('WARNING: failed loading: ' + process.env.OAUTH2_CA_CERT);
  12. console.log(e);
  13. }
  14. }
  15. var profile = {};
  16. var serviceData = {};
  17. var userinfo = {};
  18. OAuth.registerService('oidc', 2, null, function (query) {
  19. var debug = process.env.DEBUG || false;
  20. var token = getToken(query);
  21. if (debug) console.log('XXX: register token:', token);
  22. var accessToken = token.access_token || token.id_token;
  23. var expiresAt = (+new Date) + (1000 * parseInt(token.expires_in, 10));
  24. var claimsInAccessToken = (process.env.OAUTH2_ADFS_ENABLED === 'true' || process.env.OAUTH2_ADFS_ENABLED === true) || false;
  25. if(claimsInAccessToken)
  26. {
  27. // hack when using custom claims in the accessToken. On premise ADFS
  28. userinfo = getTokenContent(accessToken);
  29. }
  30. else
  31. {
  32. // normal behaviour, getting the claims from UserInfo endpoint.
  33. userinfo = getUserInfo(accessToken);
  34. }
  35. if (userinfo.ocs) userinfo = userinfo.ocs.data; // Nextcloud hack
  36. if (userinfo.metadata) userinfo = userinfo.metadata // Openshift hack
  37. if (debug) console.log('XXX: userinfo:', userinfo);
  38. serviceData.id = userinfo[process.env.OAUTH2_ID_MAP]; // || userinfo["id"];
  39. serviceData.username = userinfo[process.env.OAUTH2_USERNAME_MAP]; // || userinfo["uid"];
  40. serviceData.fullname = userinfo[process.env.OAUTH2_FULLNAME_MAP]; // || userinfo["displayName"];
  41. serviceData.accessToken = accessToken;
  42. serviceData.expiresAt = expiresAt;
  43. // If on Oracle OIM email is empty or null, get info from username
  44. if (process.env.ORACLE_OIM_ENABLED === 'true' || process.env.ORACLE_OIM_ENABLED === true) {
  45. if (userinfo[process.env.OAUTH2_EMAIL_MAP]) {
  46. serviceData.email = userinfo[process.env.OAUTH2_EMAIL_MAP];
  47. } else {
  48. serviceData.email = userinfo[process.env.OAUTH2_USERNAME_MAP];
  49. }
  50. }
  51. if (process.env.ORACLE_OIM_ENABLED !== 'true' && process.env.ORACLE_OIM_ENABLED !== true) {
  52. serviceData.email = userinfo[process.env.OAUTH2_EMAIL_MAP]; // || userinfo["email"];
  53. }
  54. if (accessToken) {
  55. var tokenContent = getTokenContent(accessToken);
  56. var fields = _.pick(tokenContent, getConfiguration().idTokenWhitelistFields);
  57. _.extend(serviceData, fields);
  58. }
  59. if (token.refresh_token)
  60. serviceData.refreshToken = token.refresh_token;
  61. if (debug) console.log('XXX: serviceData:', serviceData);
  62. profile.name = userinfo[process.env.OAUTH2_FULLNAME_MAP]; // || userinfo["displayName"];
  63. profile.email = userinfo[process.env.OAUTH2_EMAIL_MAP]; // || userinfo["email"];
  64. if (debug) console.log('XXX: profile:', profile);
  65. //temporarily store data from oidc in user.services.oidc.groups to update groups
  66. serviceData.groups = (userinfo["groups"] && userinfo["wekanGroups"]) ? userinfo["wekanGroups"] : userinfo["groups"];
  67. // groups arriving as array of strings indicate there is no scope set in oidc privider
  68. // to assign teams and keep admin privileges
  69. // data needs to be treated differently.
  70. // use case: in oidc provider no scope is set, hence no group attributes.
  71. // therefore: keep admin privileges for wekan as before
  72. if(Array.isArray(serviceData.groups) && serviceData.groups.length && typeof serviceData.groups[0] === "string" )
  73. {
  74. user = Meteor.users.findOne({'_id': serviceData.id});
  75. serviceData.groups.forEach(function(groupName, i)
  76. {
  77. if(user?.isAdmin && i == 0)
  78. {
  79. // keep information of user.isAdmin since in loginHandler the user will // be updated regarding group admin privileges provided via oidc
  80. serviceData.groups[i] = {"isAdmin": true};
  81. serviceData.groups[i]["displayName"]= groupName;
  82. }
  83. else
  84. {
  85. serviceData.groups[i] = {"displayName": groupName};
  86. }
  87. });
  88. }
  89. // Fix OIDC login loop for integer user ID. Thanks to danielkaiser.
  90. // https://github.com/wekan/wekan/issues/4795
  91. Meteor.call('groupRoutineOnLogin',serviceData, ""+serviceData.id);
  92. Meteor.call('boardRoutineOnLogin',serviceData, ""+serviceData.id);
  93. return {
  94. serviceData: serviceData,
  95. options: { profile: profile }
  96. };
  97. });
  98. var userAgent = "Meteor";
  99. if (Meteor.release) {
  100. userAgent += "/" + Meteor.release;
  101. }
  102. if (process.env.ORACLE_OIM_ENABLED !== 'true' && process.env.ORACLE_OIM_ENABLED !== true) {
  103. var getToken = function (query) {
  104. var debug = process.env.DEBUG || false;
  105. var config = getConfiguration();
  106. if(config.tokenEndpoint.includes('https://')){
  107. var serverTokenEndpoint = config.tokenEndpoint;
  108. }else{
  109. var serverTokenEndpoint = config.serverUrl + config.tokenEndpoint;
  110. }
  111. var requestPermissions = config.requestPermissions;
  112. var response;
  113. try {
  114. var postOptions = {
  115. headers: {
  116. Accept: 'application/json',
  117. "User-Agent": userAgent
  118. },
  119. params: {
  120. code: query.code,
  121. client_id: config.clientId,
  122. client_secret: OAuth.openSecret(config.secret),
  123. redirect_uri: OAuth._redirectUri('oidc', config),
  124. grant_type: 'authorization_code',
  125. state: query.state
  126. }
  127. };
  128. if (httpCa) {
  129. postOptions['npmRequestOptions'] = { ca: httpCa };
  130. }
  131. response = HTTP.post(serverTokenEndpoint, postOptions);
  132. } catch (err) {
  133. throw _.extend(new Error("Failed to get token from OIDC " + serverTokenEndpoint + ": " + err.message),
  134. { response: err.response });
  135. }
  136. if (response.data.error) {
  137. // if the http response was a json object with an error attribute
  138. throw new Error("Failed to complete handshake with OIDC " + serverTokenEndpoint + ": " + response.data.error);
  139. } else {
  140. if (debug) console.log('XXX: getToken response: ', response.data);
  141. return response.data;
  142. }
  143. };
  144. }
  145. if (process.env.ORACLE_OIM_ENABLED === 'true' || process.env.ORACLE_OIM_ENABLED === true) {
  146. var getToken = function (query) {
  147. var debug = (process.env.DEBUG === 'true' || process.env.DEBUG === true) || false;
  148. var config = getConfiguration();
  149. if(config.tokenEndpoint.includes('https://')){
  150. var serverTokenEndpoint = config.tokenEndpoint;
  151. }else{
  152. var serverTokenEndpoint = config.serverUrl + config.tokenEndpoint;
  153. }
  154. var requestPermissions = config.requestPermissions;
  155. var response;
  156. // OIM needs basic Authentication token in the header - ClientID + SECRET in base64
  157. var dataToken=null;
  158. var strBasicToken=null;
  159. var strBasicToken64=null;
  160. dataToken = process.env.OAUTH2_CLIENT_ID + ':' + process.env.OAUTH2_SECRET;
  161. strBasicToken = new Buffer(dataToken);
  162. strBasicToken64 = strBasicToken.toString('base64');
  163. // eslint-disable-next-line no-console
  164. if (debug) console.log('Basic Token: ', strBasicToken64);
  165. try {
  166. var postOptions = {
  167. headers: {
  168. Accept: 'application/json',
  169. "User-Agent": userAgent,
  170. "Authorization": "Basic " + strBasicToken64
  171. },
  172. params: {
  173. code: query.code,
  174. client_id: config.clientId,
  175. client_secret: OAuth.openSecret(config.secret),
  176. redirect_uri: OAuth._redirectUri('oidc', config),
  177. grant_type: 'authorization_code',
  178. state: query.state
  179. }
  180. };
  181. if (httpCa) {
  182. postOptions['npmRequestOptions'] = { ca: httpCa };
  183. }
  184. response = HTTP.post(serverTokenEndpoint, postOptions);
  185. } catch (err) {
  186. throw _.extend(new Error("Failed to get token from OIDC " + serverTokenEndpoint + ": " + err.message),
  187. { response: err.response });
  188. }
  189. if (response.data.error) {
  190. // if the http response was a json object with an error attribute
  191. throw new Error("Failed to complete handshake with OIDC " + serverTokenEndpoint + ": " + response.data.error);
  192. } else {
  193. // eslint-disable-next-line no-console
  194. if (debug) console.log('XXX: getToken response: ', response.data);
  195. return response.data;
  196. }
  197. };
  198. }
  199. var getUserInfo = function (accessToken) {
  200. var debug = process.env.DEBUG || false;
  201. var config = getConfiguration();
  202. // Some userinfo endpoints use a different base URL than the authorization or token endpoints.
  203. // This logic allows the end user to override the setting by providing the full URL to userinfo in their config.
  204. if (config.userinfoEndpoint.includes("https://")) {
  205. var serverUserinfoEndpoint = config.userinfoEndpoint;
  206. } else {
  207. var serverUserinfoEndpoint = config.serverUrl + config.userinfoEndpoint;
  208. }
  209. var response;
  210. try {
  211. var getOptions = {
  212. headers: {
  213. "User-Agent": userAgent,
  214. "Authorization": "Bearer " + accessToken
  215. }
  216. };
  217. if (httpCa) {
  218. getOptions['npmRequestOptions'] = { ca: httpCa };
  219. }
  220. response = HTTP.get(serverUserinfoEndpoint, getOptions);
  221. } catch (err) {
  222. throw _.extend(new Error("Failed to fetch userinfo from OIDC " + serverUserinfoEndpoint + ": " + err.message),
  223. {response: err.response});
  224. }
  225. if (debug) console.log('XXX: getUserInfo response: ', response.data);
  226. return response.data;
  227. };
  228. var getConfiguration = function () {
  229. var config = ServiceConfiguration.configurations.findOne({ service: 'oidc' });
  230. if (!config) {
  231. throw new ServiceConfiguration.ConfigError('Service oidc not configured.');
  232. }
  233. return config;
  234. };
  235. var getTokenContent = function (token) {
  236. var content = null;
  237. if (token) {
  238. try {
  239. var parts = token.split('.');
  240. var header = JSON.parse(Buffer.from(parts[0], 'base64').toString());
  241. content = JSON.parse(Buffer.from(parts[1], 'base64').toString());
  242. var signature = Buffer.from(parts[2], 'base64');
  243. var signed = parts[0] + '.' + parts[1];
  244. } catch (err) {
  245. this.content = {
  246. exp: 0
  247. };
  248. }
  249. }
  250. return content;
  251. }
  252. Meteor.methods({
  253. 'groupRoutineOnLogin': function(info, userId)
  254. {
  255. check(info, Object);
  256. check(userId, String);
  257. var propagateOidcData = process.env.PROPAGATE_OIDC_DATA || false;
  258. if (propagateOidcData)
  259. {
  260. users= Meteor.users;
  261. user = users.findOne({'services.oidc.id': userId});
  262. if(user)
  263. {
  264. //updates/creates Groups and user admin privileges accordingly
  265. addGroupsWithAttributes(user, info.groups);
  266. if(info.email) addEmail(user, info.email);
  267. if(info.fullname) changeFullname(user, info.fullname);
  268. if(info.username) changeUsername(user, info.username);
  269. }
  270. }
  271. }
  272. });
  273. Meteor.methods({
  274. 'boardRoutineOnLogin': function(info, oidcUserId)
  275. {
  276. check(info, Object);
  277. check(oidcUserId, String);
  278. const defaultBoardId = process.env.DEFAULT_BOARD_ID || false;
  279. if (defaultBoardId)
  280. {
  281. const board = Boards.findOne(defaultBoardId)
  282. const user = Users.findOne({ 'services.oidc.id': oidcUserId })
  283. const memberIndex = _.pluck(board.members, 'userId').indexOf(user._id);
  284. if(board && memberIndex < 0)
  285. {
  286. board.addMember(user._id)
  287. }
  288. }
  289. }
  290. });
  291. Oidc.retrieveCredential = function (credentialToken, credentialSecret) {
  292. return OAuth.retrieveCredential(credentialToken, credentialSecret);
  293. };