oracledb 6.8.0 → 6.9.0

package/plugins/token/extensionOci/index.js

@@ -36,6 +36,8 @@ async function getToken(params) {
       return await configFileBasedAuthentication(params);
     case 'simpleauthentication':
       return await simpleAuthentication(params);
+    case 'instanceprincipal':
+      return await instancePrincipalAuthentication(params);
     default:
       throwErr(`Invalid authentication type ${params.authType} in extensionOci plugins.`);
   }
@@ -48,6 +50,43 @@ function throwErr(message) {
   throw new Error(message);
 }
 
+//---------------------------------------------------------------------------
+// Requests an access token from the dataplane service
+// Generating security token
+//---------------------------------------------------------------------------
+async function generateAccessToken(provider, scope) {
+  // Scope uses the * character to identify all databases in the cloud
+  // tenancy of the authenticated user. urn:oracle:db::id::*, default
+
+  // A scope that authorizes access to all databases within a compartment has
+  // the form: urn:oracle:db::id::<compartment-ocid>
+  // String scope = "urn:oracle:db::id::ocid1.compartment.oc1..xxxxxxxx"
+
+  // A scope that authorizes access to a single database within a compartment
+  // has the form: urn:oracle:db::id::<compartment-ocid>::<database-ocid>
+  // String scope = "urn:oracle:db::id::ocid1.compartment.oc1..xxxxxx::ocid1.autonomousdatabase.oc1.phx.xxxxxx"
+
+  const client = new identitydataplane.DataplaneClient({
+    authenticationDetailsProvider: provider
+  });
+  const keyPair = await _getKeyPair();
+
+  const generateScopedAccessTokenRequest = {
+    generateScopedAccessTokenDetails: {
+      scope: scope ?? "urn:oracle:db::id::*",
+      publicKey: keyPair.publicKey
+    }
+  };
+
+  const generateScopedAccessTokenResponse =
+    await client.generateScopedAccessToken(generateScopedAccessTokenRequest);
+
+  return {
+    token: generateScopedAccessTokenResponse.securityToken.token,
+    privateKey: keyPair.privateKey
+  };
+}
+
 //---------------------------------------------------------------------------
 // Generates a public-private key pair for proof of possession when token
 // requested by this provider is presented for validation.
@@ -79,31 +118,33 @@ async function _getKeyPair() {
 //  scope of requested access. The request will specify a public key
 //  as being paired with a private key that the presenter of the token must
 //  prove to be in possession of.
+//
+//  The path and profile of the config file may be configured by optional
+//  parameters in object accessTokenConfig. If values not provided in
+//  accessTokenConfig then this method will read the DEFAULT
+//  profile from $HOME/.oci/config.
+//  accessTokenConfig.configFileLocation, Not null.
+//  accessTokenConfig.profile, Not null.
+//
+//  Return API Key-Based Authentication.
 //---------------------------------------------------------------------------
 async function configFileBasedAuthentication(accessTokenConfig) {
   const provider =
     new common.ConfigFileAuthenticationDetailsProvider(accessTokenConfig.configFileLocation, accessTokenConfig.profile);
-  const client = new identitydataplane.DataplaneClient({authenticationDetailsProvider: provider});
-  const keyPair = await _getKeyPair();
-  const generateScopedAccessTokenDetails = {
-    scope: "urn:oracle:db::id::*",
-    publicKey: keyPair.publicKey
-  };
 
-  const generateScopedAccessTokenRequest = {
-    generateScopedAccessTokenDetails: generateScopedAccessTokenDetails
-  };
-  const generateScopedAccessTokenResponse =
-    await client.generateScopedAccessToken(generateScopedAccessTokenRequest);
-  const obj = {
-    token: generateScopedAccessTokenResponse.securityToken.token,
-    privateKey: keyPair.privateKey
-  };
-  return obj;
+  return await generateAccessToken(provider, accessTokenConfig.scope);
 }
 
 //---------------------------------------------------------------------------
 // simpleAuthentication()
+// Returns authentication details for the provided credentials.
+//   tenancy: OCID of the tenancy
+//   user: OCID of the user
+//   fingerprint: Fingerprint of the public key
+//   privateKey: Private key
+//   passPhrase: Passphrase that is used to encrypt the private key.
+//               null if not used.
+// Return API Key-Based Authentication.
 //---------------------------------------------------------------------------
 async function simpleAuthentication(accessTokenConfig) {
   const tenancy = accessTokenConfig.tenancy ??
@@ -135,27 +176,22 @@ async function simpleAuthentication(accessTokenConfig) {
     passphrase,
     region
   );
-  const client = new identitydataplane.DataplaneClient({
-    authenticationDetailsProvider: provider
-  });
-  const keyPair = await _getKeyPair();
-  const generateScopedAccessTokenDetails = {
-    scope: "urn:oracle:db::id::*",
-    publicKey: keyPair.publicKey
-  };
-  const generateScopedAccessTokenRequest = {
-    generateScopedAccessTokenDetails: generateScopedAccessTokenDetails
-  };
 
-  const generateScopedAccessTokenResponse = await client.generateScopedAccessToken(
-    generateScopedAccessTokenRequest
-  );
+  return await generateAccessToken(provider, accessTokenConfig.scope);
+}
 
-  const obj = {
-    token: generateScopedAccessTokenResponse.securityToken.token,
-    privateKey: keyPair.privateKey
-  };
-  return obj;
+//---------------------------------------------------------------------------
+// instancePrincipalAuthentication()
+//
+// Authentication in a Compute Instance, without credentials, as an instance
+// principal. This authentication method should only work on compute
+// instances where internal network endpoints are reachable.
+// Return Instance Principal Authentication.
+//---------------------------------------------------------------------------
+async function instancePrincipalAuthentication(accessTokenConfig) {
+  const provider = await new common.InstancePrincipalsAuthenticationDetailsProviderBuilder().build();
+
+  return await generateAccessToken(provider, accessTokenConfig.scope);
 }
 
 //---------------------------------------------------------------------------

package/build/Release/oracledb-6.8.0-darwin-arm64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-6.8.0-darwin-arm64.node v22.2.0 1e47f3ef9289df6513744f8cff1ad648f989c8af 6fa744509b8144c7bd2a25a1cb1e7dd8f746d31f Wed, 12 Feb 2025 09:02:05 GMT

package/build/Release/oracledb-6.8.0-darwin-x64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-6.8.0-darwin-x64.node v20.11.1 1e47f3ef9289df6513744f8cff1ad648f989c8af 6fa744509b8144c7bd2a25a1cb1e7dd8f746d31f Wed, 12 Feb 2025 08:49:37 GMT

package/build/Release/oracledb-6.8.0-js-buildinfo.txt

@@ -1 +0,0 @@
-1e47f3ef9289df6513744f8cff1ad648f989c8af

package/build/Release/oracledb-6.8.0-linux-arm64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-6.8.0-linux-arm64.node v20.16.0 1e47f3ef9289df6513744f8cff1ad648f989c8af 6fa744509b8144c7bd2a25a1cb1e7dd8f746d31f Wed, 12 Feb 2025 09:53:19 GMT

package/build/Release/oracledb-6.8.0-linux-x64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-6.8.0-linux-x64.node v20.16.0 1e47f3ef9289df6513744f8cff1ad648f989c8af 6fa744509b8144c7bd2a25a1cb1e7dd8f746d31f Wed, 12 Feb 2025 09:52:45 GMT

package/build/Release/oracledb-6.8.0-win32-x64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-6.8.0-win32-x64.node v20.0.0 1e47f3ef9289df6513744f8cff1ad648f989c8af 6fa744509b8144c7bd2a25a1cb1e7dd8f746d31f Wed, 12 Feb 2025 09:31:59 GMT