KC-1368: Add gchat-app-setup for Google Chat integration (#2252)

* Add gchat-app-setup for Google Chat Service Mode integration.

Collect and store Google Chat/Pub/Sub credentials in a vault record and generate docker-compose, matching the Slack/Teams setup flow.

* Require a file path for Google Chat service account JSON.

Drop unreliable inline JSON paste at the gchat-app-setup prompt; service account keys are too large for single-line terminal input.

* updated to latest annotations

* addressed review comments

* Validate GChat project ID against Pub/Sub paths and the service account.

Reject full resource names whose project differs from GOOGLE_PROJECT_ID, require confirmation when the project override disagrees with the SA JSON, and drop unused _is_valid_subscription_id.

Author: sshrushanth-ks

keepercommander/command_categories.py

@@ -84,7 +84,7 @@
     'Service Mode REST API': {
         'service-create', 'service-add-config', 'service-start', 'service-stop', 'service-status',
         'service-config-add', 'service-docker-setup', 'slack-app-setup', 'teams-app-setup',
-        'sailpoint-app-setup'
+        'sailpoint-app-setup', 'gchat-app-setup'
     },
 
     # Email Configuration Commands

keepercommander/commands/start_service.py

@@ -14,7 +14,10 @@
 from ..service.commands.handle_service import StartService, StopService, ServiceStatus
 from ..service.commands.service_docker_setup import ServiceDockerSetupCommand
 from ..service.commands.integrations import (
-    SlackAppSetupCommand, TeamsAppSetupCommand, SailPointAppSetupCommand,
+    GChatAppSetupCommand,
+    SlackAppSetupCommand,
+    TeamsAppSetupCommand,
+    SailPointAppSetupCommand,
 )
 
 def register_commands(commands):
@@ -27,6 +30,7 @@ def register_commands(commands):
     commands['slack-app-setup'] = SlackAppSetupCommand()
     commands['teams-app-setup'] = TeamsAppSetupCommand()
     commands['sailpoint-app-setup'] = SailPointAppSetupCommand()
+    commands['gchat-app-setup'] = GChatAppSetupCommand()
 
 def register_command_info(aliases, command_info):
     service_classes = [
@@ -39,9 +43,10 @@ def register_command_info(aliases, command_info):
         SlackAppSetupCommand,
         TeamsAppSetupCommand,
         SailPointAppSetupCommand,
+        GChatAppSetupCommand,
     ]
 
     for service_class in service_classes:
         parser = service_class()
         p = parser.get_parser()
-        command_info[p.prog] = p.description
+        command_info[p.prog] = p.description

keepercommander/service/README.md

@@ -20,6 +20,8 @@ The Service Mode module for Keeper Commander enables REST API integration by pro
 | `service-config-add` | Add new API configuration and command access settings |
 | `service-docker-setup` | Automated Docker service mode setup with KSM configuration |
 | `slack-app-setup` | Automated Slack App integration setup with Commander Service Mode |
+| `teams-app-setup` | Automated Teams App integration setup with Commander Service Mode |
+| `gchat-app-setup` | Automated Google Chat App integration setup with Commander Service Mode |
 
 ### Security Features
 - API key authentication
@@ -500,6 +502,60 @@ This automates the complete setup for Slack App integration:
 
 The command generates a complete `docker-compose.yml` with both Commander service and Slack App service configured.
 
+### Google Chat App Integration Setup
+
+For integrating Commander Service Mode with Google Chat, use the `gchat-app-setup` command:
+
+```bash
+My Vault> gchat-app-setup
+```
+
+This automates the complete setup for Google Chat App integration:
+- **Phase 1**: Runs Docker setup (same as `service-docker-setup`)
+- **Phase 2**: Configures Google Chat App integration
+  - Collects service account JSON (Pub/Sub + Chat API worker credentials)
+  - Collects Google Project ID (defaults from the service account JSON when omitted)
+  - Collects Pub/Sub Topic ID, Subscription ID, Approvals Space ID, and slash command IDs
+  - Creates Google Chat configuration record
+  - Updates `docker-compose.yml` with Google Chat App service
+  - Supports optional EPM and Device Approval integrations
+
+**Configuration Options:**
+- Port selection (default: 8900)
+- Ngrok/Cloudflare tunneling for public URL exposure
+- Google Chat service account / Pub/Sub / space credentials
+- Optional EPM integration
+- Optional SSO Cloud Device Approval
+
+The command generates a complete `docker-compose.yml` with both Commander service and Google Chat App service configured.
+
+**Vault config record fields** (read by the Google Chat app via KSM / `GCHAT_RECORD`):
+
+| Field label | Type | Description |
+|-------------|------|-------------|
+| `google_service_account_json` | secret | Full GCP service account JSON (Pub/Sub + Chat API) |
+| `google_project_id` | text | GCP project ID |
+| `google_topic_id` | text | Pub/Sub topic ID (short form) |
+| `google_subscription_id` | text | Pub/Sub subscription ID (short form) |
+| `chat_approvals_space_id` | text | Google Chat space ID (`spaces/...`) |
+| `chat_command_request_record_id` | text | Slash command ID for `/keeper-request-record` |
+| `chat_command_request_folder_id` | text | Slash command ID for `/keeper-request-folder` |
+| `chat_command_one_time_share_id` | text | Slash command ID for `/keeper-one-time-share` |
+| `pedm_enabled` | text | `true` / `false` |
+| `pedm_polling_interval` | text | Seconds |
+| `device_approval_enabled` | text | `true` / `false` |
+| `device_approval_polling_interval` | text | Seconds |
+
+**Generated compose environment for the Google Chat service:**
+
+| Env var | Value |
+|---------|-------|
+| `KSM_CONFIG` | Base64 KSM config |
+| `COMMANDER_RECORD` | Commander Docker config record UID |
+| `GCHAT_RECORD` | Google Chat config record UID |
+
+Image name used in compose: `keeper/gchat-app:latest`.
+
 ---
 
 ### Manual Authentication Methods (Alternative)

keepercommander/service/commands/integrations/__init__.py

@@ -11,13 +11,15 @@
 
 """Integration setup commands."""
 
+from .gchat_app_setup import GChatAppSetupCommand
 from .integration_setup_base import IntegrationSetupCommand
 from .slack_app_setup import SlackAppSetupCommand
 from .teams_app_setup import TeamsAppSetupCommand
 from .sailpoint_app_setup import SailPointAppSetupCommand
 
 __all__ = [
     'IntegrationSetupCommand',
+    'GChatAppSetupCommand',
     'SlackAppSetupCommand',
     'TeamsAppSetupCommand',
     'SailPointAppSetupCommand',