@prosopo/user-access-policy 3.3.2 → 3.5.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
3
  const util = require("node:util");
4
4
  const accessRules = require("../accessRules.cjs");
5
- const redisAccessRulesIndex = require("./redisAccessRulesIndex.cjs");
5
+ const redisRulesIndex = require("./redisRulesIndex.cjs");
6
6
  function _interopNamespaceDefault(e) {
7
7
  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
8
8
  if (e) {
@@ -20,19 +20,19 @@ function _interopNamespaceDefault(e) {
20
20
  return Object.freeze(n);
21
21
  }
22
22
  const util__namespace = /* @__PURE__ */ _interopNamespaceDefault(util);
23
- const createRedisAccessRulesReader = (client, logger) => {
23
+ const createRedisRulesReader = (client, logger) => {
24
24
  return {
25
- findRules: async (filter, skipEmptyUserScopes = true) => {
26
- const query = redisAccessRulesIndex.getRedisAccessRulesQuery(filter);
25
+ findRules: async (filter, matchingFieldsOnly = false, skipEmptyUserScopes = true) => {
26
+ const query = redisRulesIndex.getRedisRulesQuery(filter, matchingFieldsOnly);
27
27
  if (skipEmptyUserScopes && query === "ismissing(@clientId)") {
28
28
  return [];
29
29
  }
30
30
  let searchReply;
31
31
  try {
32
32
  searchReply = await client.ft.search(
33
- redisAccessRulesIndex.accessRulesRedisIndexName,
33
+ redisRulesIndex.redisRulesIndexName,
34
34
  query,
35
- redisAccessRulesIndex.accessRulesRedisSearchOptions
35
+ redisRulesIndex.redisRulesSearchOptions
36
36
  );
37
37
  if (searchReply.total > 0) {
38
38
  logger.debug(() => ({
@@ -67,16 +67,16 @@ const createRedisAccessRulesReader = (client, logger) => {
67
67
  }));
68
68
  return [];
69
69
  }
70
- return extractAccessRulesFromSearchReply(searchReply, logger);
70
+ return extractRulesFromSearchReply(searchReply, logger);
71
71
  },
72
- findRuleIds: async (filter) => {
73
- const query = redisAccessRulesIndex.getRedisAccessRulesQuery(filter);
72
+ findRuleIds: async (filter, matchingFieldsOnly = false) => {
73
+ const query = redisRulesIndex.getRedisRulesQuery(filter, matchingFieldsOnly);
74
74
  let searchReply;
75
75
  try {
76
76
  searchReply = await client.ft.searchNoContent(
77
- redisAccessRulesIndex.accessRulesRedisIndexName,
77
+ redisRulesIndex.redisRulesIndexName,
78
78
  query,
79
- redisAccessRulesIndex.accessRulesRedisSearchOptions
79
+ redisRulesIndex.redisRulesSearchOptions
80
80
  );
81
81
  } catch (e) {
82
82
  logger.error(() => ({
@@ -100,38 +100,29 @@ const createRedisAccessRulesReader = (client, logger) => {
100
100
  }
101
101
  };
102
102
  };
103
- const createRedisAccessRulesWriter = (client) => {
103
+ const getDummyRedisRulesReader = (logger) => {
104
104
  return {
105
- insertRule: async (rule, expirationTimestamp) => {
106
- const ruleKey = redisAccessRulesIndex.getRedisAccessRuleKey(rule);
107
- const ruleValue = redisAccessRulesIndex.getRedisAccessRuleValue(rule);
108
- await client.hSet(ruleKey, ruleValue);
109
- if (expirationTimestamp) {
110
- const expiryDate = new Date(expirationTimestamp);
111
- if (expiryDate.getUTCFullYear() === 1970) {
112
- await client.expireAt(ruleKey, expirationTimestamp);
113
- } else {
114
- const timestampInSeconds = Math.floor(expirationTimestamp / 1e3);
115
- await client.expireAt(ruleKey, timestampInSeconds);
105
+ findRules: async (filter, matchingFieldsOnly = false, skipEmptyUserScopes = true) => {
106
+ logger.info(() => ({
107
+ msg: "Dummy findRules() has no effect (redis is not ready)",
108
+ data: {
109
+ filter
116
110
  }
117
- }
118
- return ruleKey;
111
+ }));
112
+ return [];
119
113
  },
120
- deleteRules: async (ruleIds) => void await client.del(ruleIds),
121
- deleteAllRules: async () => {
122
- const keys = await client.keys(`${redisAccessRulesIndex.accessRuleRedisKeyPrefix}*`);
123
- if (keys.length === 0) return 0;
124
- return await client.del(keys);
114
+ findRuleIds: async (filter, matchingFieldsOnly = false) => {
115
+ logger.info(() => ({
116
+ msg: "Dummy findRuleIds() has no effect (redis is not ready)",
117
+ data: {
118
+ filter
119
+ }
120
+ }));
121
+ return [];
125
122
  }
126
123
  };
127
124
  };
128
- const createRedisAccessRulesStorage = (client, logger) => {
129
- return {
130
- ...createRedisAccessRulesReader(client, logger),
131
- ...createRedisAccessRulesWriter(client)
132
- };
133
- };
134
- const extractAccessRulesFromSearchReply = (searchReply, logger) => {
125
+ const extractRulesFromSearchReply = (searchReply, logger) => {
135
126
  const accessRules$1 = [];
136
127
  searchReply.documents.map(({ id, value: document }) => {
137
128
  const parsedDocument = accessRules.accessRuleSchema.safeParse(document);
@@ -147,6 +138,5 @@ const extractAccessRulesFromSearchReply = (searchReply, logger) => {
147
138
  });
148
139
  return accessRules$1;
149
140
  };
150
- exports.createRedisAccessRulesReader = createRedisAccessRulesReader;
151
- exports.createRedisAccessRulesStorage = createRedisAccessRulesStorage;
152
- exports.createRedisAccessRulesWriter = createRedisAccessRulesWriter;
141
+ exports.createRedisRulesReader = createRedisRulesReader;
142
+ exports.getDummyRedisRulesReader = getDummyRedisRulesReader;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const redisRulesReader = require("./redisRulesReader.cjs");
4
+ const redisRulesWriter = require("./redisRulesWriter.cjs");
5
+ const createRedisAccessRulesStorage = (connection, logger) => {
6
+ const storage = {
7
+ ...redisRulesReader.getDummyRedisRulesReader(logger),
8
+ ...redisRulesWriter.getDummyRedisRulesWriter(logger)
9
+ };
10
+ connection.getClient().then((client) => {
11
+ Object.assign(storage, {
12
+ ...redisRulesReader.createRedisRulesReader(client, logger),
13
+ ...redisRulesWriter.createRedisRulesWriter(client)
14
+ });
15
+ logger.info(() => ({
16
+ msg: "RedisAccessRules storage got a ready Redis client"
17
+ }));
18
+ });
19
+ return storage;
20
+ };
21
+ exports.createRedisAccessRulesStorage = createRedisAccessRulesStorage;
@@ -0,0 +1,73 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const crypto = require("node:crypto");
4
+ const redisRulesIndex = require("./redisRulesIndex.cjs");
5
+ const redisRuleContentHashAlgorithm = "md5";
6
+ const createRedisRulesWriter = (client) => {
7
+ return {
8
+ insertRule: async (rule, expirationTimestamp) => {
9
+ const ruleKey = getRedisRuleKey(rule);
10
+ const ruleValue = getRedisRuleValue(rule);
11
+ await client.hSet(ruleKey, ruleValue);
12
+ if (expirationTimestamp) {
13
+ const expiryDate = new Date(expirationTimestamp);
14
+ if (expiryDate.getUTCFullYear() === 1970) {
15
+ await client.expireAt(ruleKey, expirationTimestamp);
16
+ } else {
17
+ const timestampInSeconds = Math.floor(expirationTimestamp / 1e3);
18
+ await client.expireAt(ruleKey, timestampInSeconds);
19
+ }
20
+ }
21
+ return ruleKey;
22
+ },
23
+ deleteRules: async (ruleIds) => void await client.del(ruleIds),
24
+ deleteAllRules: async () => {
25
+ const keys = await client.keys(`${redisRulesIndex.redisRuleKeyPrefix}*`);
26
+ if (keys.length === 0) return 0;
27
+ return await client.del(keys);
28
+ }
29
+ };
30
+ };
31
+ const getDummyRedisRulesWriter = (logger) => {
32
+ return {
33
+ insertRule: async (rule, expirationTimestamp) => {
34
+ logger.info(() => ({
35
+ msg: "Dummy insertRule() has no effect (redis is not ready)",
36
+ data: {
37
+ rule
38
+ }
39
+ }));
40
+ return "";
41
+ },
42
+ deleteRules: async (ruleIds) => {
43
+ logger.info(() => ({
44
+ msg: "Dummy deleteRules() has no effect (redis is not ready)",
45
+ data: {
46
+ ruleIds
47
+ }
48
+ }));
49
+ },
50
+ deleteAllRules: async () => {
51
+ logger.info(() => ({
52
+ msg: "Dummy deleteAllRules() has no effect (redis is not ready)"
53
+ }));
54
+ return 0;
55
+ }
56
+ };
57
+ };
58
+ const getRedisRuleKey = (rule) => redisRulesIndex.redisRuleKeyPrefix + crypto.createHash(redisRuleContentHashAlgorithm).update(
59
+ JSON.stringify(
60
+ rule,
61
+ (key, value) => (
62
+ // JSON.stringify can't handle BigInt itself: throws "Do not know how to serialize a BigInt"
63
+ "bigint" === typeof value ? value.toString() : value
64
+ )
65
+ )
66
+ ).digest("hex");
67
+ const getRedisRuleValue = (rule) => Object.fromEntries(
68
+ Object.entries(rule).map(([key, value]) => [key, String(value)])
69
+ );
70
+ exports.createRedisRulesWriter = createRedisRulesWriter;
71
+ exports.getDummyRedisRulesWriter = getDummyRedisRulesWriter;
72
+ exports.getRedisRuleKey = getRedisRuleKey;
73
+ exports.getRedisRuleValue = getRedisRuleValue;
package/dist/index.js CHANGED
@@ -1,28 +1,32 @@
1
- import { AccessPolicyType, accessPolicySchema, policyScopeSchema, userScopeInputSchema } from "./accessPolicy.js";
2
- import { ScopeMatch, createAccessPolicyResolver } from "./accessPolicyResolver.js";
1
+ import { AccessPolicyType, accessPolicySchema, accessRuleSchemaExtended, policyScopeSchema, userScopeInputSchema } from "./accessPolicy.js";
2
+ import { ScopeMatch } from "./accessPolicyResolver.js";
3
+ import { accessRuleSchema } from "./accessRules.js";
3
4
  import { AccessRuleApiRoutes } from "./api/accessRuleApiRoutes.js";
4
5
  import { accessRuleApiPaths, getExpressApiRuleRateLimits } from "./api/accessRuleApiRoutes.js";
5
6
  import { deleteAllRulesEndpointSchema } from "./api/deleteAllRulesEndpoint.js";
6
7
  import { deleteRulesEndpointSchema } from "./api/deleteRulesEndpoint.js";
7
8
  import { insertRulesEndpointSchema } from "./api/insertRulesEndpoint.js";
8
- import { createRedisAccessRulesStorage } from "./redis/redisAccessRules.js";
9
- import { createRedisAccessRulesIndex } from "./redis/redisAccessRulesIndex.js";
9
+ import { createRedisAccessRulesStorage } from "./redis/redisRulesStorage.js";
10
+ import { redisAccessRulesIndex } from "./redis/redisRulesIndex.js";
11
+ import { AccessRulesApiClient } from "./api/accessRulesApiClient.js";
10
12
  const createApiRuleRoutesProvider = (rulesStorage) => {
11
13
  return new AccessRuleApiRoutes(rulesStorage);
12
14
  };
13
15
  export {
14
16
  AccessPolicyType,
17
+ AccessRulesApiClient,
15
18
  ScopeMatch,
16
19
  accessPolicySchema,
17
20
  accessRuleApiPaths,
18
- createAccessPolicyResolver,
21
+ accessRuleSchema,
22
+ accessRuleSchemaExtended,
19
23
  createApiRuleRoutesProvider,
20
- createRedisAccessRulesIndex,
21
24
  createRedisAccessRulesStorage,
22
25
  deleteAllRulesEndpointSchema,
23
26
  deleteRulesEndpointSchema,
24
27
  getExpressApiRuleRateLimits,
25
28
  insertRulesEndpointSchema,
26
29
  policyScopeSchema,
30
+ redisAccessRulesIndex,
27
31
  userScopeInputSchema
28
32
  };
@@ -0,0 +1,138 @@
1
+ import { SCHEMA_FIELD_TYPE } from "@redis/search";
2
+ import { userScopeSchema } from "../accessPolicy.js";
3
+ import { ScopeMatch } from "../accessPolicyResolver.js";
4
+ const redisRulesIndexName = "index:user-access-rules";
5
+ const redisRuleKeyPrefix = "uar:";
6
+ const redisAccessRulesIndex = {
7
+ name: redisRulesIndexName,
8
+ /**
9
+ * Note on the field type decision
10
+ *
11
+ * TAG is designed for the exact value matching
12
+ * TEXT is designed for the word-based and pattern matching
13
+ *
14
+ * For our goal TAG fits perfectly and, more performant
15
+ */
16
+ schema: {
17
+ clientId: {
18
+ type: SCHEMA_FIELD_TYPE.TAG,
19
+ // necessary to make possible use of the ismissing() function on this field in the search
20
+ INDEXMISSING: true
21
+ },
22
+ numericIpMaskMin: { type: SCHEMA_FIELD_TYPE.NUMERIC, INDEXMISSING: true },
23
+ numericIpMaskMax: { type: SCHEMA_FIELD_TYPE.NUMERIC, INDEXMISSING: true },
24
+ userId: { type: SCHEMA_FIELD_TYPE.TAG, INDEXMISSING: true },
25
+ numericIp: { type: SCHEMA_FIELD_TYPE.NUMERIC, INDEXMISSING: true },
26
+ ja4Hash: { type: SCHEMA_FIELD_TYPE.TAG, INDEXMISSING: true },
27
+ headersHash: { type: SCHEMA_FIELD_TYPE.TAG, INDEXMISSING: true },
28
+ userAgentHash: { type: SCHEMA_FIELD_TYPE.TAG, INDEXMISSING: true }
29
+ },
30
+ // the satisfy statement is to guarantee that the keys are right
31
+ options: {
32
+ ON: "HASH",
33
+ PREFIX: [redisRuleKeyPrefix]
34
+ }
35
+ };
36
+ const numericIndexFields = [
37
+ "numericIp",
38
+ "numericIpMaskMin",
39
+ "numericIpMaskMax"
40
+ ];
41
+ const greedyFieldComparisons = {
42
+ numericIp: (value, scope) => {
43
+ if (value !== void 0) {
44
+ return `( @numericIp:[${value}] | ( @numericIpMaskMin:[-inf ${value}] @numericIpMaskMax:[${value} +inf] ) )`;
45
+ }
46
+ if (scope.numericIpMaskMin === void 0 && scope.numericIpMaskMax === void 0) {
47
+ return "ismissing(@numericIp) ismissing(@numericIpMaskMin) ismissing(@numericIpMaskMax)";
48
+ }
49
+ return "";
50
+ },
51
+ numericIpMaskMin: (value, scope) => {
52
+ if (scope.numericIp !== void 0) {
53
+ return "";
54
+ }
55
+ return value !== void 0 ? `@numericIpMaskMin:[-inf ${value}]` : "ismissing(@numericIpMaskMin)";
56
+ },
57
+ numericIpMaskMax: (value, scope) => {
58
+ if (scope.numericIp !== void 0) {
59
+ return "";
60
+ }
61
+ return value !== void 0 ? `@numericIpMaskMax:[${value} +inf]` : "ismissing(@numericIpMaskMax)";
62
+ }
63
+ };
64
+ const redisRulesSearchOptions = {
65
+ // #2 is a required option when the 'ismissing()' function is in the query body
66
+ DIALECT: 2
67
+ };
68
+ const getRedisRulesQuery = (filter, matchingFieldsOnly) => {
69
+ const { policyScope, userScope } = filter;
70
+ const policyScopeFilter = getPolicyScopeQuery(
71
+ policyScope,
72
+ filter.policyScopeMatch
73
+ );
74
+ if (userScope && Object.keys(userScope).length > 0) {
75
+ const userScopeFilter = getUserScopeQuery(
76
+ userScope,
77
+ filter.userScopeMatch,
78
+ matchingFieldsOnly
79
+ );
80
+ return `${policyScopeFilter} ( ${userScopeFilter} )`;
81
+ }
82
+ return policyScopeFilter ? policyScopeFilter : "*";
83
+ };
84
+ const getPolicyScopeQuery = (policyScope, scopeMatchType) => {
85
+ const clientId = policyScope?.clientId;
86
+ if ("string" === typeof clientId) {
87
+ return ScopeMatch.Exact === scopeMatchType ? `@clientId:{${clientId}}` : `( @clientId:{${clientId}} | ismissing(@clientId) )`;
88
+ }
89
+ return ScopeMatch.Exact === scopeMatchType ? "ismissing(@clientId)" : "";
90
+ };
91
+ const getUserScopeQuery = (userScope, scopeMatchType, matchingFieldsOnly) => {
92
+ let scopeEntries = Object.entries(userScope);
93
+ let scopeJoinType = " ";
94
+ if (scopeMatchType === ScopeMatch.Greedy) {
95
+ scopeEntries = scopeEntries.filter(
96
+ ([_, value]) => value !== void 0
97
+ );
98
+ scopeJoinType = " | ";
99
+ }
100
+ if (matchingFieldsOnly) {
101
+ const scopeMap = new Map(scopeEntries);
102
+ if (scopeMap.has("numericIp") && scopeMap.get("numericIp") === void 0) {
103
+ scopeMap.set("numericIpMaskMin", void 0);
104
+ scopeMap.set("numericIpMaskMax", void 0);
105
+ }
106
+ for (const name of Object.keys(userScopeSchema.shape)) {
107
+ if (!scopeMap.has(name)) {
108
+ scopeMap.set(name, void 0);
109
+ }
110
+ }
111
+ scopeEntries = [...scopeMap.entries()];
112
+ }
113
+ const scopeObj = Object.fromEntries(scopeEntries);
114
+ return scopeEntries.map(
115
+ ([scopeFieldName, scopeFieldValue]) => getUserScopeFieldQuery(
116
+ scopeFieldName,
117
+ scopeFieldValue,
118
+ scopeMatchType,
119
+ scopeObj
120
+ )
121
+ ).filter(Boolean).join(scopeJoinType);
122
+ };
123
+ const getUserScopeFieldQuery = (fieldName, fieldValue, matchType, fullScope) => {
124
+ if ("function" === typeof greedyFieldComparisons[fieldName]) {
125
+ return greedyFieldComparisons[fieldName](fieldValue, fullScope);
126
+ }
127
+ if (fieldValue === void 0) {
128
+ return `ismissing(@${fieldName})`;
129
+ }
130
+ return numericIndexFields.includes(fieldName) ? `@${fieldName}:[${fieldValue}]` : `@${fieldName}:{${fieldValue}}`;
131
+ };
132
+ export {
133
+ getRedisRulesQuery,
134
+ redisAccessRulesIndex,
135
+ redisRuleKeyPrefix,
136
+ redisRulesIndexName,
137
+ redisRulesSearchOptions
138
+ };
@@ -1,19 +1,19 @@
1
1
  import * as util from "node:util";
2
2
  import { accessRuleSchema } from "../accessRules.js";
3
- import { getRedisAccessRulesQuery, accessRulesRedisIndexName, accessRulesRedisSearchOptions, accessRuleRedisKeyPrefix, getRedisAccessRuleKey, getRedisAccessRuleValue } from "./redisAccessRulesIndex.js";
4
- const createRedisAccessRulesReader = (client, logger) => {
3
+ import { getRedisRulesQuery, redisRulesIndexName, redisRulesSearchOptions } from "./redisRulesIndex.js";
4
+ const createRedisRulesReader = (client, logger) => {
5
5
  return {
6
- findRules: async (filter, skipEmptyUserScopes = true) => {
7
- const query = getRedisAccessRulesQuery(filter);
6
+ findRules: async (filter, matchingFieldsOnly = false, skipEmptyUserScopes = true) => {
7
+ const query = getRedisRulesQuery(filter, matchingFieldsOnly);
8
8
  if (skipEmptyUserScopes && query === "ismissing(@clientId)") {
9
9
  return [];
10
10
  }
11
11
  let searchReply;
12
12
  try {
13
13
  searchReply = await client.ft.search(
14
- accessRulesRedisIndexName,
14
+ redisRulesIndexName,
15
15
  query,
16
- accessRulesRedisSearchOptions
16
+ redisRulesSearchOptions
17
17
  );
18
18
  if (searchReply.total > 0) {
19
19
  logger.debug(() => ({
@@ -48,16 +48,16 @@ const createRedisAccessRulesReader = (client, logger) => {
48
48
  }));
49
49
  return [];
50
50
  }
51
- return extractAccessRulesFromSearchReply(searchReply, logger);
51
+ return extractRulesFromSearchReply(searchReply, logger);
52
52
  },
53
- findRuleIds: async (filter) => {
54
- const query = getRedisAccessRulesQuery(filter);
53
+ findRuleIds: async (filter, matchingFieldsOnly = false) => {
54
+ const query = getRedisRulesQuery(filter, matchingFieldsOnly);
55
55
  let searchReply;
56
56
  try {
57
57
  searchReply = await client.ft.searchNoContent(
58
- accessRulesRedisIndexName,
58
+ redisRulesIndexName,
59
59
  query,
60
- accessRulesRedisSearchOptions
60
+ redisRulesSearchOptions
61
61
  );
62
62
  } catch (e) {
63
63
  logger.error(() => ({
@@ -81,38 +81,29 @@ const createRedisAccessRulesReader = (client, logger) => {
81
81
  }
82
82
  };
83
83
  };
84
- const createRedisAccessRulesWriter = (client) => {
84
+ const getDummyRedisRulesReader = (logger) => {
85
85
  return {
86
- insertRule: async (rule, expirationTimestamp) => {
87
- const ruleKey = getRedisAccessRuleKey(rule);
88
- const ruleValue = getRedisAccessRuleValue(rule);
89
- await client.hSet(ruleKey, ruleValue);
90
- if (expirationTimestamp) {
91
- const expiryDate = new Date(expirationTimestamp);
92
- if (expiryDate.getUTCFullYear() === 1970) {
93
- await client.expireAt(ruleKey, expirationTimestamp);
94
- } else {
95
- const timestampInSeconds = Math.floor(expirationTimestamp / 1e3);
96
- await client.expireAt(ruleKey, timestampInSeconds);
86
+ findRules: async (filter, matchingFieldsOnly = false, skipEmptyUserScopes = true) => {
87
+ logger.info(() => ({
88
+ msg: "Dummy findRules() has no effect (redis is not ready)",
89
+ data: {
90
+ filter
97
91
  }
98
- }
99
- return ruleKey;
92
+ }));
93
+ return [];
100
94
  },
101
- deleteRules: async (ruleIds) => void await client.del(ruleIds),
102
- deleteAllRules: async () => {
103
- const keys = await client.keys(`${accessRuleRedisKeyPrefix}*`);
104
- if (keys.length === 0) return 0;
105
- return await client.del(keys);
95
+ findRuleIds: async (filter, matchingFieldsOnly = false) => {
96
+ logger.info(() => ({
97
+ msg: "Dummy findRuleIds() has no effect (redis is not ready)",
98
+ data: {
99
+ filter
100
+ }
101
+ }));
102
+ return [];
106
103
  }
107
104
  };
108
105
  };
109
- const createRedisAccessRulesStorage = (client, logger) => {
110
- return {
111
- ...createRedisAccessRulesReader(client, logger),
112
- ...createRedisAccessRulesWriter(client)
113
- };
114
- };
115
- const extractAccessRulesFromSearchReply = (searchReply, logger) => {
106
+ const extractRulesFromSearchReply = (searchReply, logger) => {
116
107
  const accessRules = [];
117
108
  searchReply.documents.map(({ id, value: document }) => {
118
109
  const parsedDocument = accessRuleSchema.safeParse(document);
@@ -129,7 +120,6 @@ const extractAccessRulesFromSearchReply = (searchReply, logger) => {
129
120
  return accessRules;
130
121
  };
131
122
  export {
132
- createRedisAccessRulesReader,
133
- createRedisAccessRulesStorage,
134
- createRedisAccessRulesWriter
123
+ createRedisRulesReader,
124
+ getDummyRedisRulesReader
135
125
  };
@@ -0,0 +1,21 @@
1
+ import { getDummyRedisRulesReader, createRedisRulesReader } from "./redisRulesReader.js";
2
+ import { getDummyRedisRulesWriter, createRedisRulesWriter } from "./redisRulesWriter.js";
3
+ const createRedisAccessRulesStorage = (connection, logger) => {
4
+ const storage = {
5
+ ...getDummyRedisRulesReader(logger),
6
+ ...getDummyRedisRulesWriter(logger)
7
+ };
8
+ connection.getClient().then((client) => {
9
+ Object.assign(storage, {
10
+ ...createRedisRulesReader(client, logger),
11
+ ...createRedisRulesWriter(client)
12
+ });
13
+ logger.info(() => ({
14
+ msg: "RedisAccessRules storage got a ready Redis client"
15
+ }));
16
+ });
17
+ return storage;
18
+ };
19
+ export {
20
+ createRedisAccessRulesStorage
21
+ };
@@ -0,0 +1,73 @@
1
+ import crypto from "node:crypto";
2
+ import { redisRuleKeyPrefix } from "./redisRulesIndex.js";
3
+ const redisRuleContentHashAlgorithm = "md5";
4
+ const createRedisRulesWriter = (client) => {
5
+ return {
6
+ insertRule: async (rule, expirationTimestamp) => {
7
+ const ruleKey = getRedisRuleKey(rule);
8
+ const ruleValue = getRedisRuleValue(rule);
9
+ await client.hSet(ruleKey, ruleValue);
10
+ if (expirationTimestamp) {
11
+ const expiryDate = new Date(expirationTimestamp);
12
+ if (expiryDate.getUTCFullYear() === 1970) {
13
+ await client.expireAt(ruleKey, expirationTimestamp);
14
+ } else {
15
+ const timestampInSeconds = Math.floor(expirationTimestamp / 1e3);
16
+ await client.expireAt(ruleKey, timestampInSeconds);
17
+ }
18
+ }
19
+ return ruleKey;
20
+ },
21
+ deleteRules: async (ruleIds) => void await client.del(ruleIds),
22
+ deleteAllRules: async () => {
23
+ const keys = await client.keys(`${redisRuleKeyPrefix}*`);
24
+ if (keys.length === 0) return 0;
25
+ return await client.del(keys);
26
+ }
27
+ };
28
+ };
29
+ const getDummyRedisRulesWriter = (logger) => {
30
+ return {
31
+ insertRule: async (rule, expirationTimestamp) => {
32
+ logger.info(() => ({
33
+ msg: "Dummy insertRule() has no effect (redis is not ready)",
34
+ data: {
35
+ rule
36
+ }
37
+ }));
38
+ return "";
39
+ },
40
+ deleteRules: async (ruleIds) => {
41
+ logger.info(() => ({
42
+ msg: "Dummy deleteRules() has no effect (redis is not ready)",
43
+ data: {
44
+ ruleIds
45
+ }
46
+ }));
47
+ },
48
+ deleteAllRules: async () => {
49
+ logger.info(() => ({
50
+ msg: "Dummy deleteAllRules() has no effect (redis is not ready)"
51
+ }));
52
+ return 0;
53
+ }
54
+ };
55
+ };
56
+ const getRedisRuleKey = (rule) => redisRuleKeyPrefix + crypto.createHash(redisRuleContentHashAlgorithm).update(
57
+ JSON.stringify(
58
+ rule,
59
+ (key, value) => (
60
+ // JSON.stringify can't handle BigInt itself: throws "Do not know how to serialize a BigInt"
61
+ "bigint" === typeof value ? value.toString() : value
62
+ )
63
+ )
64
+ ).digest("hex");
65
+ const getRedisRuleValue = (rule) => Object.fromEntries(
66
+ Object.entries(rule).map(([key, value]) => [key, String(value)])
67
+ );
68
+ export {
69
+ createRedisRulesWriter,
70
+ getDummyRedisRulesWriter,
71
+ getRedisRuleKey,
72
+ getRedisRuleValue
73
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prosopo/user-access-policy",
3
- "version": "3.3.2",
3
+ "version": "3.5.19",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "type": "module",
@@ -20,26 +20,31 @@
20
20
  },
21
21
  "scripts": {
22
22
  "clean": "del-cli --verbose dist tsconfig.tsbuildinfo",
23
- "build": "NODE_ENV=${NODE_ENV:-production}; vite build --config vite.esm.config.ts --mode $NODE_ENV",
23
+ "build": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.esm.config.ts --mode $NODE_ENV",
24
24
  "build:tsc": "tsc --build --verbose",
25
- "build:cjs": "NODE_ENV=${NODE_ENV:-production}; vite build --config vite.cjs.config.ts --mode $NODE_ENV",
26
- "typecheck": "tsc --build --declaration --emitDeclarationOnly --force",
27
- "test": "NODE_ENV=${NODE_ENV:-test}; npx vitest run --config ./vite.test.config.ts"
25
+ "build:cjs": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV",
26
+ "typecheck": "tsc --project tsconfig.types.json",
27
+ "test:unit": "NODE_ENV=${NODE_ENV:-test}; TEST_TYPE=unit npx vitest run --config ./vite.test.config.ts",
28
+ "test:integration": "NODE_ENV=${NODE_ENV:-test}; NX_PARALLEL=1 TEST_TYPE=integration npx vitest run --config ./vite.test.config.ts",
29
+ "test": "npm run test:unit && npm run test:integration"
28
30
  },
29
31
  "dependencies": {
30
- "@prosopo/api-route": "2.6.9",
31
- "@prosopo/common": "3.1.1",
32
- "@prosopo/types": "3.0.5",
33
- "@prosopo/util": "3.0.4",
34
- "axios": "1.10.0",
35
- "esbuild": "0.25.6",
32
+ "@prosopo/api": "3.1.24",
33
+ "@prosopo/api-route": "2.6.28",
34
+ "@prosopo/common": "3.1.20",
35
+ "@prosopo/redis-client": "1.0.5",
36
+ "@prosopo/types": "3.5.3",
37
+ "@prosopo/util": "3.1.5",
38
+ "@redis/search": "5.0.0",
39
+ "dotenv": "16.4.5",
36
40
  "ip-address": "10.0.1",
37
41
  "redis": "5.0.0",
38
- "zod": "3.23.8",
39
- "@prosopo/config": "3.1.2",
40
- "webpack-dev-server": "5.2.2"
42
+ "zod": "3.23.8"
41
43
  },
42
44
  "devDependencies": {
45
+ "@prosopo/config": "3.1.20",
46
+ "@prosopo/util-crypto": "13.5.22",
47
+ "@types/node": "22.10.2",
43
48
  "vite": "6.3.5",
44
49
  "vitest": "3.0.9",
45
50
  "yargs": "17.7.2"