msauthify

1. 📔 Description
2. ⚠️ Before running
3. 🔨 Installation
4. ✍️ Usage
5. 📑 Options
6. 🧐 Examples
7. 📃 License
8. ❤️ Contribution

# Description

msauthify is a Node.js application for automating OAuth2 authentication with Microsoft services. It retrieves access tokens by leveraging the resource owner password credentials grant flow. This tool simplifies authentication for developers working with Microsoft APIs.

# Before Running

Ensure that your AWS SSO profiles are configured using aws sso configure and your profiles are configured in a JSON file named msauthify.config. The format of the configuration file should include the following details:

• custom_application_name: Custom application name.
  • tenantId: The Microsoft Azure tenant ID.
  • clientId: The application (client) ID from Azure.
  • clientSecret: The client secret for the application.
  • scope: The API scopes requested.
  • username: The username of the account for authentication.
  • password: The password of the account for authentication.

The msauthify.config file should be placed as follows:

• Linux/macOS: ~/msauthify.config
• Windows: %userprofile%\msauthify.config

# Installation

npm i -g msauthify

# Usage

Basic usage example:

msauthify <profile>

A profile is required. Use --list to see the available profiles defined in msauthify.config.

The application will authenticate using the credentials provided in msauthify.config and output the access token.

# Options

Option	Description
-l, --list	List available profiles from msauthify.config
-d, --decode	Decode the JWT and output its header and payload as JSON
-c, --copy	Copy the token to the system clipboard
-h, --help	Show help
-v, --version	Show version

--copy works on macOS, Windows and Linux out of the box (powered by clipboardy).

Combine --copy with --decode to copy the decoded JWT (as JSON) instead of the raw token.

# Examples

Linux: ~/msauthify.config
Windows: %userprofile%/msauthify.config

{
    "custom_application_name_1": {    
        "tenantId": "app1_tenantId",
        "clientId": "app1_clientId",
        "clientSecret": "app1_clientSecret",
        "scope": "app1_scope",
        "username": "app1_user@example.com",
        "password": "app1_password"
    },
    "custom_application_name_2": {    
        "tenantId": "app2_tenantId",
        "clientId": "app2_clientId",
        "clientSecret": "app2_clientSecret",
        "scope": "app2_scope",
        "username": "app2_user@example.com",
        "password": "app2_password"
    },
    ...
}

Token Output:

$ msauthify custom_application_name_1
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Inp...

List Profiles Output:

$ msauthify --list
custom_application_name_1
custom_application_name_2

Decoded JWT Output:

$ msauthify --decode custom_application_name_1
{
  "header": {
    "typ": "JWT",
    "alg": "RS256",
    "kid": "..."
  },
  "payload": {
    "aud": "...",
    "iss": "...",
    "exp": 1700000000,
    "scp": "...",
    ...
  }
}

Copy Token to Clipboard:

$ msauthify --copy custom_application_name_1
Token for 'custom_application_name_1' copied to clipboard

# License

Distributed under the MIT License. See LICENSE for more information.

# Contributing

We welcome contributions to improve the functionality of msauthify! Here's how you can contribute:

1. Fork the project
2. Create a new feature branch (git checkout -b feature/YourFeature)
3. Make your changes and commit (git commit -m 'Add feature')
4. Push to your branch (git push origin feature/YourFeature)
5. Open a pull request

Your contributions will be greatly appreciated!

⭐ Feel free to contribute ⭐