History

Brodin d6d85f2ffe adding local files for running this....locally		2024-09-23 19:05:38 -04:00
..
lib	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
LICENSE	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
package.json	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
README.md	adding local files for running this....locally	2024-09-23 19:05:38 -04:00

README.md

AWS SSL Profiles

AWS RDS SSL Certificates Bundles.

Table of Contents

Installation
Usage
License
Security
Contributing
Acknowledgements

Installation

npm install --save aws-ssl-profiles

Usage

mysqljs/mysql

const mysql = require('mysql');
const awsCaBundle = require('aws-ssl-profiles');

// mysql connection
const connection = mysql.createConnection({
  //...
  ssl: awsCaBundle,
});

// mysql connection pool
const pool = mysql.createPool({
  //...
  ssl: awsCaBundle,
});

MySQL2

const mysql = require('mysql2');
const awsCaBundle = require('aws-ssl-profiles');

// mysql2 connection
const connection = mysql.createConnection({
  //...
  ssl: awsCaBundle,
});

// mysql2 connection pool
const pool = mysql.createPool({
  //...
  ssl: awsCaBundle,
});

node-postgres

const pg = require('pg');
const awsCaBundle = require('aws-ssl-profiles');

// pg connection
const client = new pg.Client({
  // ...
  ssl: awsCaBundle,
});

// pg connection pool
const pool = new pg.Pool({
  // ...
  ssl: awsCaBundle,
});

Custom `ssl` options

Using AWS SSL Profiles with custom ssl options:

{
  // ...
  ssl: {
    ...awsCaBundle,
    rejectUnauthorized: true,
    // ...
  }
}

{
  // ...
  ssl: {
    ca: awsCaBundle.ca,
    rejectUnauthorized: true,
    // ...
  }
}

Custom bundles

const { proxyBundle } = require('aws-ssl-profiles');

{
  // ...
  ssl: proxyBundle,
}

License

AWS SSL Profiles is under the MIT License.

Security

Please check the SECURITY.md.

Contributing

Please check the CONTRIBUTING.md for instructions.

Acknowledgements

Contributors.