Skip to content
NodeJS example of uploading a file to Oracle Cloud Infrastructure Object Storage - using signed REST API calls
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
configs
services
utils
.gitignore
configuration.js
func.js
func.yaml
logger.js
package-lock.json
package.json
readme.md
saveObject.js
your-privkey.pem

readme.md

Save File to Oracle Cloud Infrastructure Object Storage from Node through REST API

This repository contains an example of how to upload a file to Oracle Cloud Infrastructure from a Node application using the OCI REST APIs. In a very similar way, we can invoke other REST APIs for other OCI services.

You have to provide configuration details, including a private key file, your tenancy, user, compartment, public key fingerprint etc.

runShippingExtractionJob("myNewFile.json", { content: "My very very special Content", moreContent: "Something completely different", value: 34 })

Note: this code can be used inside an Function running on Project Fn and on Oracle Functions. The func.js script and the func.yaml file define a function that can be deployed and invoked.

Also read this blog article Save File to Oracle Cloud Infrastructure Object Storage from Node through REST API

Installing & Running

Clone this Repository

Run npm install

Make Fixes in Node Module HTTP-Signature

Due to a bug in http-signature (see this article) you need to make a few manual fixes in file node_modules\http-signature\lib\signer.js in order to make signing work with a private key file that is protected with a passphrase:

At line 293 I inserted the following: assert.optionalString(options.passphrase, 'options.passphrase');

At line 363 (formerly line 362) I modifed the line to the following to propagate the options object: key = sshpk.parsePrivateKey(options.key, 'auto', options);

Copy your Private Key file into the project

At one point, you have probably used openssl genrsa to generate a private key (protected wuth a passphrase) resulting in a *.pem file. Please copy this file into the project. In the next step, you have to set the relative location of this file in the configuration.js file - property privateKeyFile.

Logging

The code is configured to use the Papertrail service for logging.

You will need to update the logger.js file if you do not want to use Papertrail - but a different logging service or just a local one.

Configure your environment parameters in confguration.js

File configuration.js contains all environment specific settings for your Cloud Tenancy, Compartment, User, Public Fingerprint and Private Key. Update this file with your own settings.

Resources

Crucial resources:

Fix for http-signature to wok with passphrase

GitHub Repo OCI-Rest-APIs-nodejs by Christopher Beck with foundation for invoking many OCI REST APIs from NodeJS - I have used crucial elements from this example

Papertrail Logging Service

Medium Article: Logging in NodeJS using Papertrail

OCI Object Storage Service Documentation

You can’t perform that action at this time.