brianllevado123/bw-zoho-guard

Secures and facilitates the communication between Bitwarden and Zoho by acting as a middleware, ensuring safe and authenticated handshakes for API requests.

1.0.0 2025-01-17 04:05 UTC

README

Installation

You can install the package via composer:

composer require brianllevado123/bw-zoho-guard

You can publish the config file with:

php artisan vendor:publish --tag="BWZohoGuard-config"

This is the contents of the published config file:

return [
    'api_key' => env('API_KEY', 'default_api_key'),
    'master_password' => env('MASTER_PASSWORD', 'default_password'),
    'bitwarden_url' => env('BITWARDEN_URL', 'http://localhost'),
];

Add the service provider to config/app.php:

'brianllevado123\BWZohoGuard\BWZohoGuardServiceProvider::class',

Clear routes:

php artisan route:clear

Usage

Endpoint:

This API endpoint allows you to interact with the Bitwarden API by making requests with a specified endpoint, method, and payload.

https://{domain-name}/api/bitwarden-api-request

Request Body:

The request body should be a JSON object with the following properties.

{
    "bw_api_endpoint": "{string}", // The Bitwarden API endpoint to interact with. Example: "/object/folder"
    "bw_request_method": "{string}", // The HTTP request method to use. Example: "post", "get", "put", "delete"
    "bw_request_payload": {collection} // The data to send with the request
}
{
    "bw_api_endpoint": "/object/folder",
    "bw_request_method": "post",
    "bw_request_payload": {
        "name": "Folder Name"
    }
}

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.