Skip to content

Commit 4eff276

Browse files
authored
Remove deprecated field privateCert from README, tests (#591)
1 parent 6a7e476 commit 4eff276

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ As a convenience, the strategy object exposes a `generateServiceProviderMetadata
229229

230230
The `decryptionCert` argument should be a public certificate matching the `decryptionPvk` and is required if the strategy is configured with a `decryptionPvk`.
231231

232-
The `signingCert` argument should be a public certificate matching the `privateCert` and is required if the strategy is configured with a `privateCert`.
232+
The `signingCert` argument should be a public certificate matching the `privateKey` and is required if the strategy is configured with a `privateKey`.
233233

234234
The `generateServiceProviderMetadata` method is also available on the `MultiSamlStrategy`, but needs an extra request and a callback argument (`generateServiceProviderMetadata( req, decryptionCert, signingCert, next )`), which are passed to the `getSamlOptions` to retrieve the correct configuration.
235235

@@ -279,7 +279,7 @@ See example from tests of [singleline private key](test/static/singleline_acme_t
279279
Add it to strategy options like this:
280280

281281
```javascript
282-
privateCert: fs.readFileSync("./privateCert.pem", "utf-8");
282+
privateKey: fs.readFileSync("./privateKey.pem", "utf-8");
283283
```
284284

285285
It is a good idea to validate the signatures of the incoming SAML Responses. For this, you can provide the Identity Provider's public PEM-encoded X.509 signing certificate using the `cert` configuration key. The "BEGIN CERTIFICATE" and "END CERTIFICATE" lines should be stripped out and the certificate should be provided on a single line.

docs/adfs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ passport.use(
4545
entryPoint: "https://adfs.acme_tools.com/adfs/ls/",
4646
issuer: "acme_tools_com",
4747
callbackUrl: "https://acme_tools.com/adfs/postResponse",
48-
privateCert: fs.readFileSync("/path/to/acme_tools_com.key", "utf-8"),
48+
privateKey: fs.readFileSync("/path/to/acme_tools_com.key", "utf-8"),
4949
cert: fs.readFileSync("/path/to/adfs.acme_tools.com.crt", "utf-8"),
5050
// other authn contexts are available e.g. windows single sign-on
5151
authnContext:

test/node-saml/tests.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ describe("node-saml /", function () {
355355
testMetadata(samlConfig, expectedMetadata);
356356
});
357357

358-
it("config with protocol, path, host, decryptionPvk and privateCert should pass", function () {
358+
it("config with protocol, path, host, decryptionPvk and privateKey should pass", function () {
359359
const samlConfig = {
360360
issuer: "http://example.serviceprovider.com",
361361
protocol: "http://",

0 commit comments

Comments
 (0)