armoriq-sdk-dev 0.3.1__tar.gz

armoriq_sdk_dev-0.3.1/.env.example

@@ -0,0 +1,33 @@
+# ArmorIQ SDK Configuration Template
+# Copy this file to .env and fill in your actual values
+
+# Environment Mode
+# Set to "development" for local testing, "production" for live services
+ARMORIQ_ENV=production
+
+# Production Endpoints (default when ARMORIQ_ENV=production)
+# IAP_ENDPOINT=https://customer-iap.armoriq.ai
+# PROXY_ENDPOINT=https://cloud-run-customer-proxy.armoriq.ai
+# CONMAP_ENDPOINT=https://customer-api.armoriq.ai
+
+# Development/Local Endpoints (uncomment for local testing)
+# IAP_ENDPOINT=http://localhost:8082
+# PROXY_ENDPOINT=http://localhost:3001
+# CONMAP_ENDPOINT=http://localhost:3000
+
+# Agent Configuration (REQUIRED)
+AGENT_ID=my-agent
+USER_ID=test-user-123
+
+# Optional Configuration
+# CONTEXT_ID=default
+# PROJECT_ID=test-project-456
+
+# API Keys (if required by your services)
+# ARMORIQ_API_KEY=your-api-key-here
+
+# Logging
+LOG_LEVEL=INFO
+
+# Development Settings
+DEBUG_MODE=false

armoriq_sdk_dev-0.3.1/CHANGELOG.md

@@ -0,0 +1,101 @@
+# Changelog
+
+All notable changes to ArmorIQ SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-01-26
+
+### Added
+- **API Key Authentication**: Mandatory API key validation on SDK initialization
+- **Production Endpoints**: Updated default endpoints for customer platform:
+  - IAP: `https://customer-iap.armoriq.ai`
+  - Proxy: `https://customer-proxy.armoriq.ai`
+  - ConMap: `https://customer-api.armoriq.ai`
+  - Dashboard: `https://platform.armoriq.ai/dashboard/api-keys`
+- **Dual-Mode Support**: Local development and production modes
+  - Production mode (default): Uses customer-*.armoriq.ai endpoints
+  - Local mode: Uses localhost endpoints for development
+  - Toggle via `use_production=False` parameter
+  - Environment variable: `ARMORIQ_ENV=development`
+- **API Key Management**: Integration with API Key Dashboard
+  - API keys required in format: `ak_live_*` or `ak_test_*`
+  - Set via environment variable: `ARMORIQ_API_KEY`
+  - Or pass directly: `ArmorIQClient(api_key="ak_live_...")`
+- **Documentation**:
+  - `API_KEY_GUIDE.md`: Complete guide for API key usage
+  - `PRODUCTION_VS_LOCAL.md`: Dual-mode configuration guide
+  - Updated `examples/complete_workflow.py` with API key examples
+
+### Changed
+- **BREAKING**: API key now required for SDK initialization
+  - Raises `ConfigurationException` if API key is missing
+  - API key format validation enforced
+- Updated all default endpoints to customer-specific URLs
+- Improved error messages for authentication failures
+- Enhanced configuration validation
+
+### Security
+- API key validation with bcrypt hash verification
+- Secure key prefix lookup via database indexing
+- Fire-and-forget usage tracking for performance
+- Production token signing with GCP KMS
+- Local development uses Ed25519 signing
+
+## [0.1.0] - 2026-01-16
+
+### Added
+- Initial beta release of ArmorIQ SDK
+- Core `ArmorIQClient` class with CSRG-IAP integration
+- Production endpoints configured by default:
+  - IAP: `https://customer-iap.armoriq.ai`
+  - Proxy: `https://cloud-run-customer-proxy.armoriq.ai`
+  - ConMap: `https://customer-api.armoriq.ai`
+- Automatic environment detection (`ARMORIQ_ENV`)
+- Flexible endpoint configuration (env vars, parameters, per-MCP)
+- Core APIs:
+  - `capture_plan()` - Plan canonicalization with CSRG
+  - `get_intent_token()` - Token acquisition from IAP with Ed25519 signatures
+  - `invoke()` - MCP action invocation through proxy
+  - `delegate()` - Agent-to-agent delegation with public key cryptography
+- Custom exceptions:
+  - `InvalidTokenException`
+  - `IntentMismatchException`
+  - `TokenExpiredException`
+  - `MCPInvocationException`
+  - `DelegationException`
+  - `ConfigurationException`
+- Pydantic models for type safety:
+  - `IntentToken`
+  - `PlanCapture`
+  - `MCPInvocation`
+  - `MCPInvocationResult`
+  - `DelegationRequest`
+  - `DelegationResult`
+  - `SDKConfig`
+- Token caching with expiry checking
+- Comprehensive error handling
+- Environment variable configuration support
+- Context manager support for resource cleanup
+- Example scripts:
+  - Basic agent usage
+  - Multi-MCP coordination
+  - Agent delegation
+  - Error handling patterns
+- Full test suite with pytest
+- Development documentation
+- README with quick start guide
+
+### Dependencies
+- `httpx>=0.27.0` - HTTP client
+- `pydantic>=2.0.0` - Data validation
+- `csrg-iap>=0.1.0` - CSRG canonicalization
+
+### Notes
+- This is an alpha release for testing and feedback
+- API may change in future versions
+- Requires CSRG-IAP service running
+- Requires ArmorIQ Proxy service for MCP invocations
+
+[0.1.0]: https://github.com/armoriq/armoriq-sdk-python/releases/tag/v0.1.0

armoriq_sdk_dev-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ArmorIQ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

armoriq_sdk_dev-0.3.1/MANIFEST.in

@@ -0,0 +1,14 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include requirements.txt
+include .env.example
+recursive-include armoriq_sdk *.py
+recursive-include docs *.md *.rst
+recursive-include examples *.py *.md
+prune tests
+prune .github
+prune __pycache__
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__

armoriq_sdk_dev-0.3.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: armoriq-sdk-dev
+Version: 0.3.1
+Summary: ArmorIQ SDK - Build secure AI agents with cryptographic intent verification.
+Home-page: https://armoriq.ai
+Author: ArmorIQ Team
+Author-email: ArmorIQ Team <license@armoriq.io>
+License: MIT
+Project-URL: Homepage, https://armoriq.ai
+Project-URL: Documentation, https://docs.armoriq.ai
+Project-URL: Source Code, https://github.com/armoriq/armoriq-sdk-python
+Keywords: armoriq,sdk,ai,agents,security,verification
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: crewai
+Requires-Dist: crewai>=0.28.0; extra == "crewai"
+Provides-Extra: langchain
+Requires-Dist: langchain>=0.1.0; extra == "langchain"
+Provides-Extra: google-adk
+Requires-Dist: google-adk>=1.0.0; extra == "google-adk"
+Provides-Extra: openai
+Requires-Dist: openai>=1.0.0; extra == "openai"
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.20.0; extra == "anthropic"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Provides-Extra: all
+Requires-Dist: crewai>=0.28.0; extra == "all"
+Requires-Dist: langchain>=0.1.0; extra == "all"
+Requires-Dist: google-adk>=1.0.0; extra == "all"
+Requires-Dist: openai>=1.0.0; extra == "all"
+Requires-Dist: anthropic>=0.20.0; extra == "all"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# ArmorIQ SDK
+
+**Build secure AI agents with cryptographic intent verification.**
+
+The ArmorIQ SDK enables developers to build AI agents with built-in security and auditability. Just one API key - no cloud complexity.
+
+---
+
+## Why ArmorIQ?
+
+- **Simple** - Just one API key, no cloud credentials
+- **Secure** - Cryptographic verification for every action
+- **Auditable** - Complete execution trail
+- **Fast** - Get started in 5 minutes
+
+---
+
+## Installation
+
+```bash
+pip install armoriq-sdk
+```
+
+CLI commands are also available after install:
+
+```bash
+armoriq --help
+```
+
+---
+
+## Quick Start
+
+### 1. Get Your API Key
+
+Visit [platform.armoriq.ai](https://platform.armoriq.ai) to generate your API key.
+
+### 2. Initialize the Client
+
+```python
+from armoriq_sdk import ArmorIQClient
+
+client = ArmorIQClient(
+    api_key="ak_your_key_here",
+    user_id="your-user-id",
+    agent_id="your-agent-id"
+)
+```
+
+Or load SDK settings from `armoriq.yaml` generated by the CLI:
+
+```python
+from armoriq_sdk import ArmorIQClient
+
+client = ArmorIQClient.from_config("armoriq.yaml")
+```
+
+### 3. Capture Your Plan
+
+```python
+plan = {
+    "goal": "Get weather forecast",
+    "steps": [
+        {
+            "action": "get_weather",
+            "tool": "weather_api",
+            "inputs": {"city": "Boston"}
+        }
+    ]
+}
+
+plan_capture = client.capture_plan(
+    llm="gpt-4",
+    prompt="What's the weather in Boston?",
+    plan=plan
+)
+```
+
+### 4. Get Intent Token
+
+```python
+token = client.get_intent_token(plan_capture)
+```
+
+### 5. Invoke Actions
+
+```python
+result = client.invoke(
+    mcp_name="weather-mcp",
+    action="get_weather",
+    intent_token=token,
+    inputs={"city": "Boston"}
+)
+
+print(result)
+```
+
+---
+
+## Documentation
+
+For complete documentation, visit [docs.armoriq.ai](https://docs.armoriq.ai)
+
+---
+
+## Links
+
+- [armoriq.ai](https://armoriq.ai)
+- [docs.armoriq.ai](https://docs.armoriq.ai)
+- [platform.armoriq.ai](https://platform.armoriq.ai)
+
+---
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

armoriq_sdk_dev-0.3.1/README.md

@@ -0,0 +1,116 @@
+# ArmorIQ SDK
+
+**Build secure AI agents with cryptographic intent verification.**
+
+The ArmorIQ SDK enables developers to build AI agents with built-in security and auditability. Just one API key - no cloud complexity.
+
+---
+
+## Why ArmorIQ?
+
+- **Simple** - Just one API key, no cloud credentials
+- **Secure** - Cryptographic verification for every action
+- **Auditable** - Complete execution trail
+- **Fast** - Get started in 5 minutes
+
+---
+
+## Installation
+
+```bash
+pip install armoriq-sdk
+```
+
+CLI commands are also available after install:
+
+```bash
+armoriq --help
+```
+
+---
+
+## Quick Start
+
+### 1. Get Your API Key
+
+Visit [platform.armoriq.ai](https://platform.armoriq.ai) to generate your API key.
+
+### 2. Initialize the Client
+
+```python
+from armoriq_sdk import ArmorIQClient
+
+client = ArmorIQClient(
+    api_key="ak_your_key_here",
+    user_id="your-user-id",
+    agent_id="your-agent-id"
+)
+```
+
+Or load SDK settings from `armoriq.yaml` generated by the CLI:
+
+```python
+from armoriq_sdk import ArmorIQClient
+
+client = ArmorIQClient.from_config("armoriq.yaml")
+```
+
+### 3. Capture Your Plan
+
+```python
+plan = {
+    "goal": "Get weather forecast",
+    "steps": [
+        {
+            "action": "get_weather",
+            "tool": "weather_api",
+            "inputs": {"city": "Boston"}
+        }
+    ]
+}
+
+plan_capture = client.capture_plan(
+    llm="gpt-4",
+    prompt="What's the weather in Boston?",
+    plan=plan
+)
+```
+
+### 4. Get Intent Token
+
+```python
+token = client.get_intent_token(plan_capture)
+```
+
+### 5. Invoke Actions
+
+```python
+result = client.invoke(
+    mcp_name="weather-mcp",
+    action="get_weather",
+    intent_token=token,
+    inputs={"city": "Boston"}
+)
+
+print(result)
+```
+
+---
+
+## Documentation
+
+For complete documentation, visit [docs.armoriq.ai](https://docs.armoriq.ai)
+
+---
+
+## Links
+
+- [armoriq.ai](https://armoriq.ai)
+- [docs.armoriq.ai](https://docs.armoriq.ai)
+- [platform.armoriq.ai](https://platform.armoriq.ai)
+
+---
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

armoriq_sdk_dev-0.3.1/armoriq_sdk/__init__.py

@@ -0,0 +1,129 @@
+"""
+ArmorIQ SDK - Build Secure AI Agents
+
+A Python SDK for building AI agents with cryptographic intent verification.
+Provides simple APIs for plan capture, token management, and secure MCP
+tool invocation with built-in security.
+
+Author: ArmorIQ Team <license@armoriq.io>
+"""
+
+from .client import ArmorIQClient
+from .session import (
+    ArmorIQSession,
+    EnforceResult,
+    ReportOptions,
+    SessionMode,
+    SessionOptions,
+)
+from .plan_builder import (
+    ToolNameParser,
+    build_plan_from_tool_calls,
+    default_tool_name_parser,
+    hash_tool_calls,
+)
+from .exceptions import (
+    ArmorIQException,
+    ConfigurationException,
+    DelegationException,
+    IntentMismatchException,
+    InvalidTokenException,
+    MCPInvocationException,
+    PolicyBlockedException,
+    PolicyHoldException,
+    TokenExpiredException,
+)
+from .models import (
+    ApprovedDelegation,
+    DelegationRequest,
+    DelegationRequestParams,
+    DelegationRequestResult,
+    DelegationResult,
+    HoldInfo,
+    IntentToken,
+    InvokeOptions,
+    MCPInvocation,
+    MCPInvocationResult,
+    MCPSemanticMetadata,
+    McpCredential,
+    McpCredentialMap,
+    PlanCapture,
+    PolicyContext,
+    SDKConfig,
+    ToolCall,
+    ToolSemanticEntry,
+)
+
+__version__ = "0.2.12"
+VERSION = __version__
+__author__ = "ArmorIQ Team"
+AUTHOR = __author__
+__email__ = "license@armoriq.io"
+EMAIL = __email__
+
+__all__ = [
+    # Core
+    "ArmorIQClient",
+    "ArmorIQSession",
+    "SessionOptions",
+    "SessionMode",
+    "EnforceResult",
+    "ReportOptions",
+    # Plan helpers
+    "build_plan_from_tool_calls",
+    "default_tool_name_parser",
+    "hash_tool_calls",
+    "ToolNameParser",
+    # Exceptions
+    "ArmorIQException",
+    "InvalidTokenException",
+    "IntentMismatchException",
+    "MCPInvocationException",
+    "TokenExpiredException",
+    "DelegationException",
+    "ConfigurationException",
+    "PolicyBlockedException",
+    "PolicyHoldException",
+    # Models
+    "IntentToken",
+    "PlanCapture",
+    "MCPInvocation",
+    "MCPInvocationResult",
+    "DelegationRequest",
+    "DelegationResult",
+    "SDKConfig",
+    "MCPSemanticMetadata",
+    "ToolSemanticEntry",
+    "PolicyContext",
+    "InvokeOptions",
+    "HoldInfo",
+    "DelegationRequestParams",
+    "DelegationRequestResult",
+    "ApprovedDelegation",
+    "ToolCall",
+    "McpCredential",
+    "McpCredentialMap",
+    # Metadata
+    "VERSION",
+    "AUTHOR",
+    "EMAIL",
+]
+
+# Optional framework integrations (each requires its own extra to be installed)
+try:
+    from .integrations import (
+        ArmorIQAnthropic,
+        ArmorIQCrew,
+        ArmorIQGoogleADK,
+        ArmorIQLangChain,
+        ArmorIQOpenAI,
+    )
+    __all__ += [
+        "ArmorIQCrew",
+        "ArmorIQLangChain",
+        "ArmorIQGoogleADK",
+        "ArmorIQOpenAI",
+        "ArmorIQAnthropic",
+    ]
+except Exception:
+    pass

armoriq_sdk_dev-0.3.1/armoriq_sdk/_build_env.py

@@ -0,0 +1,45 @@
+"""
+Build-time environment marker.
+
+This file is the ONLY difference between the `dev` and `main` branches —
+merging dev → main conflicts on this single constant, which is intentional
+so the release owner consciously flips the default before publishing prod.
+
+  main branch  →  ARMORIQ_ENV = "production"  (prod URLs; published as stable)
+  dev  branch  →  ARMORIQ_ENV = "staging"     (staging URLs; published as -dev)
+
+The baked constant is the ONLY source of truth for which environment's
+URLs to use — no runtime env-var override. To point the SDK at staging,
+install the dev build; to override a specific endpoint for testing,
+pass `backend_endpoint=...` to the ArmorIQClient constructor or set
+BACKEND_ENDPOINT / IAP_ENDPOINT / PROXY_ENDPOINT env vars.
+"""
+
+ARMORIQ_ENV: str = "staging"
+
+# Endpoint table — keep in sync with GCP Cloud Run domain mappings
+# (verified via `gcloud beta run domain-mappings describe --domain=...`).
+#   prod:
+#     api.armoriq.ai        → conmap-auto            (us-central1)
+#     iap.armoriq.ai        → csrg-execution-service (us-central1)
+#     proxy.armoriq.ai      → armoriq-proxy-server   (us-central1)
+#   staging:
+#     staging-api.armoriq.ai          → conmap-auto-staging            (us-central1)
+#     iap-staging.armoriq.ai          → csrg-execution-service-staging (us-central1)
+#     cloud-run-proxy.armoriq.io      → armoriq-proxy-dev              (europe-west1)
+ENDPOINTS = {
+    "production": {
+        "backend": "https://api.armoriq.ai",
+        "proxy": "https://proxy.armoriq.ai",
+        "iap": "https://iap.armoriq.ai",
+    },
+    "staging": {
+        "backend": "https://staging-api.armoriq.ai",
+        "proxy": "https://cloud-run-proxy.armoriq.io",
+        "iap": "https://iap-staging.armoriq.ai",
+    },
+}
+
+
+def resolve(kind: str) -> str:
+    return ENDPOINTS[ARMORIQ_ENV][kind]