Skip to content

Latest commit

 

History

History
229 lines (176 loc) · 5.14 KB

README.md

File metadata and controls

229 lines (176 loc) · 5.14 KB
Raw

Unofficial Node.js Library for OnStar Requests

This repository contains an unofficial Node.js library designed to facilitate interaction with OnStar services. It provides support for secure authentication using PKCE (Proof Key for Code Exchange) flows, token management, and Multi-Factor Authentication (MFA), as well as issuing commands to OnStar-enabled vehicles. Use at your own risk as this is an unofficial implementation.

Features

Note: This code is based on https://github.com/metheos/node-oauth2-gm.

  • PKCE Authentication Flow: Implements the PKCE flow for secure authentication without requiring a client secret.
  • MFA Support: Requests and verifies Multi-Factor Authentication codes via email.
  • Token Management: Handles saving, loading, and refreshing tokens securely.
  • Vehicle Commands: Provides endpoints to send requests such as locking/unlocking doors, starting the vehicle, and diagnostics.
  • Utility Functions: Modular codebase with reusable utility functions.

Prerequisites

  • Node.js (v18 or later)
  • npm or yarn

Installation

  1. Clone the repository:

    git clone [email protected]:joelvandal/node-oauth2-gm.git
cd node-oauth2-gm

  2. Install dependencies:

    npm install

  3. Configure environment variables: Copy the provided .env.example file to .env:

    cp .env.example .env

    Example .env file content:

    API_TOKEN=my_secure_api_token
HOST=localhost
PORT=3000
    • The API_TOKEN can be left empty, but if specified, the API will require Bearer authentication.
    • Replace localhost with 0.0.0.0 to listen on all interfaces.

Project Structure

.
├── auth/
│   ├── app.js          # Main application file
│   ├── commands.js     # Command definitions for vehicle interactions
│   ├── config.js       # Configuration settings
│   ├── sessions.js     # Session management for users
│   └── utils.js        # Utility functions for authentication
├── package.json        # Dependencies and scripts
├── .env.example        # Example environment configuration
└── README.md           # Documentation

Usage

  1. Start the server:

    npm start

    The server will run at http://0.0.0.0:3000.

  2. For development, use the following command to enable hot-reloading:

    npm run dev

Endpoints

/auth

  • Method: POST
  • Description: Initiates the PKCE flow and sends user credentials.
  • Request Body: 
    {
  "email": "[email protected]",
  "password": "securepassword"
}
  • Response: 
    {
  "success": true,
  "message": "MFA request sent. Check your email."
}

/mfa

  • Method: POST
  • Description: Submits the MFA code for verification.
  • Request Body: 
    {
  "email": "[email protected]",
  "code": "123456"
}
  • Response: 
    {
  "success": true,
  "message": "MFA completed, tokens saved."
}

/start

  • Method: POST
  • Description: Starts a session using a previously saved token.
  • Request Body: 
    {
  "email": "[email protected]",
  "vin": "vehicle_id",
  "uuid": "device_uuid"
}
  • Response: 
    {
  "success": true
}

/vehicles

  • Method: POST

  • Description: Retrieves the list of vehicles linked to the user's account.

  • Request Body:

    {
  "email": "[email protected]",
  "uuid": "device_uuid"
}

  • Response:

    {
  "success": true,
  "data": {
    "vehicles": [
      { "vin": "1234567890ABCDEF", "make": "Chevrolet", "model": "Malibu" },
      { "vin": "0987654321FEDCBA", "make": "GMC", "model": "Terrain" }
    ]
  }
}

    In case of an error:

    {
  "success": false,
  "error": "Unauthorized",
  "statusCode": 401
}

Vehicle Commands

Commands include:

  • start
  • cancelStart
  • lockDoor
  • unlockDoor
  • lockTrunk
  • unlockTrunk
  • location
  • alert
  • cancelAlert
  • diagnostics

All commands require the following parameters in the request body:

{
  "email": "[email protected]",
  "vin": "vehicle_id",
  "uuid": "device_uuid"
}

Notes on UUID

Use a random version 4 UUID as the deviceId for vehicle interactions. This ensures uniqueness and compatibility with the OnStar service.

Scripts

  • npm start: Starts the server.
  • npm run dev: Starts the server with hot-reloading for development.

Dependencies

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Contact

For any inquiries or support, please reach out at [email protected].