Skip to content

Adds TLS redis configuration support for encryption-at-rest enabled redis instances #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Adds TLS redis configuration support for encryption-at-rest enabled redis instances #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
/libpeerconnection.log
npm-debug.log
testem.log
/.vscode
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,6 @@ The Redis client to be used to upload files to the Redis store. By default this

A message that will be displayed after the file has been successfully uploaded to Redis. By default this message will only display if the revision for `revisionData.revisionKey` of the deployment context has been activated.

*Default:*

```javascript
if (context.revisionData.revisionKey && !context.revisionData.activatedRevisionKey) {
return "Deployed but did not activate revision " + context.revisionData.revisionKey + ". "
Expand All @@ -168,6 +166,12 @@ if (context.revisionData.revisionKey && !context.revisionData.activatedRevisionK
}
```

### tls

An optional tls configuration object for connecting to redis instances with encryption-in-transit enabled. Please see [https://github.com/luin/ioredis#tls-options](https://github.com/luin/ioredis#tls-options) for available options

*Default:* `null`

### maxRecentUploads

The maximum number of recent revisions to keep in Redis.
Expand Down
3 changes: 2 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ module.exports = {
url: pluginHelper.readConfig('url'),
host: pluginHelper.readConfig('host'),
port: pluginHelper.readConfig('port'),
tls: pluginHelper.readConfig('tls'),
password: pluginHelper.readConfig('password'),
database: pluginHelper.readConfig('database'),
maxRecentUploads: pluginHelper.readConfig('maxRecentUploads'),
Expand Down Expand Up @@ -82,7 +83,7 @@ module.exports = {
}
}

['filePattern', 'distDir', 'keyPrefix', 'activationSuffix', 'activeContentSuffix', 'revisionKey', 'didDeployMessage', 'redisDeployClient', 'maxRecentUploads', 'revisionData'].forEach(this.applyDefaultConfigProperty.bind(this));
['filePattern', 'distDir', 'keyPrefix', 'activationSuffix', 'activeContentSuffix', 'revisionKey', 'didDeployMessage', 'redisDeployClient', 'maxRecentUploads', 'revisionData','tls'].forEach(this.applyDefaultConfigProperty.bind(this));

this.log('config ok', { verbose: true });
},
Expand Down
4 changes: 4 additions & 0 deletions lib/redis.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ module.exports = CoreObject.extend({
if (options.database) {
redisOptions.db = options.database;
}

if (options.tls) {
redisOptions.tls = options.tls
}
}

if (!RedisLib) {
Expand Down
62 changes: 55 additions & 7 deletions tests/unit/index-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,54 @@ describe("redis plugin", function() {
});
});

describe("resolving tls from the pipeline", function() {
it("uses the config data if it already exists", function() {
var plugin = subject.createDeployPlugin({
name: "redis"
});

var config = {
host: "somehost",
port: 1234,
tls: {
secure: false
}
};
var context = {
ui: mockUi,
project: stubProject,
config: {
redis: config
}
};

plugin.beforeHook(context);
plugin.configure(context);
assert.deepEqual(plugin.readConfig("tls"), { secure: false });
});

it("resolves to undefined if not specified in config", function() {
var plugin = subject.createDeployPlugin({
name: "redis"
});

var config = {
host: "somehost"
};
var context = {
ui: mockUi,
project: stubProject,
config: {
redis: config
}
};

plugin.beforeHook(context);
plugin.configure(context);
assert.equal(plugin.readConfig("tls"), undefined);
});
})

describe("resolving revisionKey from the pipeline", function() {
it("uses the config data if it already exists", function() {
var plugin = subject.createDeployPlugin({
Expand Down Expand Up @@ -359,7 +407,7 @@ describe("redis plugin", function() {

return previous;
}, []);
assert.equal(messages.length, 12);
assert.equal(messages.length, 13);
});
it("adds default config to the config object", function() {
plugin.configure(context);
Expand Down Expand Up @@ -389,7 +437,7 @@ describe("redis plugin", function() {
};
plugin.beforeHook(context);
});
it("warns about missing optional filePattern, distDir, activationSuffix, revisionKey, didDeployMessage, maxNumberOfRecentUploads, and connection info", function() {
it("warns about missing optional filePattern, distDir, activationSuffix, revisionKey, didDeployMessage, maxNumberOfRecentUploads, and connection info, tls", function() {
plugin.configure(context);
var messages = mockUi.messages.reduce(function(previous, current) {
if (/- Missing config:\s.*, using default:\s/.test(current)) {
Expand All @@ -398,7 +446,7 @@ describe("redis plugin", function() {

return previous;
}, []);
assert.equal(messages.length, 11);
assert.equal(messages.length, 12);
});
it("does not add default config to the config object", function() {
plugin.configure(context);
Expand Down Expand Up @@ -429,7 +477,7 @@ describe("redis plugin", function() {
};
plugin.beforeHook(context);
});
it("warns about missing optional filePattern, distDir, keyPrefix, revisionKey, didDeployMessage, maxNumberOfRecentUploads, and connection info", function() {
it("warns about missing optional filePattern, distDir, keyPrefix, revisionKey, didDeployMessage, maxNumberOfRecentUploads, tls, and connection info", function() {
plugin.configure(context);
var messages = mockUi.messages.reduce(function(previous, current) {
if (/- Missing config:\s.*, using default:\s/.test(current)) {
Expand All @@ -438,7 +486,7 @@ describe("redis plugin", function() {

return previous;
}, []);
assert.equal(messages.length, 11);
assert.equal(messages.length, 12);
});
it("does not add default config to the config object", function() {
plugin.configure(context);
Expand Down Expand Up @@ -469,7 +517,7 @@ describe("redis plugin", function() {
};
plugin.beforeHook(context);
});
it("warns about missing optional filePattern, distDir, keyPrefix, activationSuffix, revisionKey, maxNumberOfRecentUploads, and didDeployMessage only", function() {
it("warns about missing optional filePattern, distDir, keyPrefix, activationSuffix, revisionKey, maxNumberOfRecentUploads, tls, and didDeployMessage only", function() {
plugin.configure(context);
var messages = mockUi.messages.reduce(function(previous, current) {
if (/- Missing config:\s.*, using default:\s/.test(current)) {
Expand All @@ -478,7 +526,7 @@ describe("redis plugin", function() {

return previous;
}, []);
assert.equal(messages.length, 10);
assert.equal(messages.length, 11);
});

it("does not add default config to the config object", function() {
Expand Down