Naming and Usage

[wellwelwel]

Naming

In sidorares/node-mysql2#2581 (comment), the suggested name was awsCaBundle.

We should use this?

Currently, the temporary name is just profiles.

---

Usage

Based in the current temporary name and prioritizing not breaking changes.

mysqljs/mysql and node-mysql2

const profiles = require('aws-ssl-profiles').profiles;

exports['Amazon RDS'] = profiles;

• 

---

CJS (directly)

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

const conn = mysql.createConnection({
  ssl: profiles,
);

---

ESM (directly)

import { profiles } from 'aws-ssl-profiles';
// ...

const conn = mysql.createConnection({
  ssl: profiles,
);

---

ℹ️ Notes

• The current profiles match the exact profiles from MySQL2 3.9.4.
  • Naturally, it doesn't fix any issues, such as HANDSHAKE_SSL_ERROR with RDS and 3.9.3+ sidorares/node-mysql2#2581.
  • A simple alternative could be to organize the unique certificates from versions < 3.9.4 and >= 3.9.4.
• I opted to use named exports instead of default exports to simplify use (and development) for both CJS and ESM. Please let me know if it's a problem.

[sidorares]

can we just have it as a default export, so we don't need to think about name?

import profiles from 'aws-ssl-profiles';

also in mysql2 lib/constants/ssl_profiles.js we export an object with profiles where only key currently is 'Amazon RDS'. I think the intention was to add later more profiles from other known services. Given that we haven't added any other, and repo name suggests it's aws focused, maybe we can just export here the content of reauire('lib/constants/ssl_profiles.js')['Amazon RDS']

Happy to discuss the scope here, and we at the stage when we can rename things easily:

• Are the any other AWS services that have different cert bundle?
• Are there any other popular services that might benefit from a npm packaged cert distribution?

[wellwelwel]

can we just have it as a default export, so we don't need to think about name?

Of couse 🙋🏻‍♂️

[wellwelwel]

maybe we can just export here the content of reauire('lib/constants/ssl_profiles.js')['Amazon RDS']

So, that's the current situation, but I just did a copy/paste, except for the TypeScript adaptation 🙋🏻‍♂️

https://github.com/mysqljs/aws-ssl-profiles/blob/2a986994cd4066ce083f6d41d21b48b22d10477a/src/profiles/ca/defaults.ts

---

Lastly, I created it in a way that we can add more certificates dinamically.

For example, the default option would be to bring in all the certificates, but we can also use an export for each certificate category individually.