oauth-sign

What is oauth-sign?

The oauth-sign npm package provides utilities for signing OAuth 1.0 and 2.0 requests. It supports HMAC-SHA1, RSA-SHA1, and PLAINTEXT signing methods, making it easier to generate OAuth signatures for HTTP requests.

What are oauth-sign's main functionalities?

HMAC-SHA1 Signing

This feature allows you to generate an HMAC-SHA1 signature for an OAuth request. The code sample demonstrates how to use the `hmacsign` method to create a signature using the consumer secret, token secret, and base string.

const oauth = require('oauth-sign');
const consumerSecret = 'consumerSecret';
const tokenSecret = 'tokenSecret';
const baseString = 'baseString';
const signature = oauth.hmacsign('GET', baseString, consumerSecret, tokenSecret);
console.log(signature);

RSA-SHA1 Signing

This feature allows you to generate an RSA-SHA1 signature for an OAuth request. The code sample demonstrates how to use the `rsasign` method to create a signature using the private key and base string.

const oauth = require('oauth-sign');
const privateKey = 'privateKey';
const baseString = 'baseString';
const signature = oauth.rsasign('GET', baseString, privateKey);
console.log(signature);

PLAINTEXT Signing

This feature allows you to generate a PLAINTEXT signature for an OAuth request. The code sample demonstrates how to use the `plaintext` method to create a signature using the consumer secret and token secret.

const oauth = require('oauth-sign');
const consumerSecret = 'consumerSecret';
const tokenSecret = 'tokenSecret';
const signature = oauth.plaintext(consumerSecret, tokenSecret);
console.log(signature);

Other packages similar to oauth-sign

oauth-1.0a

The oauth-1.0a package provides a more comprehensive implementation of OAuth 1.0a, including request signing and header generation. It supports HMAC-SHA1 and PLAINTEXT signing methods, similar to oauth-sign, but also includes additional utilities for managing OAuth parameters and generating authorization headers.

simple-oauth2

The simple-oauth2 package is designed for OAuth 2.0 and provides utilities for managing access tokens, refreshing tokens, and making authenticated requests. While it focuses on OAuth 2.0, it offers a more modern and streamlined approach compared to oauth-sign, which supports both OAuth 1.0 and 2.0.

node-oauth

The node-oauth package is a comprehensive library for OAuth 1.0 and 2.0, providing utilities for request signing, token management, and making authenticated requests. It offers a broader range of features compared to oauth-sign, including support for various OAuth flows and token types.

README

oauth-sign

OAuth 1 signing. Formerly a vendor lib in mikeal/request, now a standalone module.

Supported Method Signatures

• HMAC-SHA1
• HMAC-SHA256
• RSA-SHA1
• PLAINTEXT