wehub-resource-sync
179 lines
5.1 KiB
Markdown
179 lines
5.1 KiB
Markdown
---
|
|
search:
|
|
exclude: true
|
|
---
|
|
# 暗号化セッション
|
|
|
|
`EncryptedSession` は、任意のセッション実装に透過的な暗号化を提供し、古いアイテムの自動期限切れによって会話データを保護します。
|
|
|
|
## 機能
|
|
|
|
- **透過的な暗号化**: 任意のセッションを Fernet 暗号化でラップします
|
|
- **セッションごとのキー**: HKDF キー導出を使用して、セッションごとに一意の暗号化を行います
|
|
- **自動期限切れ**: TTL が期限切れになると、古いアイテムは取得時に黙ってスキップされます
|
|
- **ドロップイン置換**: 既存の任意のセッション実装で動作します
|
|
|
|
## インストール
|
|
|
|
暗号化セッションには `encrypt` extra が必要です。
|
|
|
|
```bash
|
|
pip install openai-agents[encrypt]
|
|
```
|
|
|
|
## クイックスタート
|
|
|
|
```python
|
|
import asyncio
|
|
from agents import Agent, Runner
|
|
from agents.extensions.memory import EncryptedSession, SQLAlchemySession
|
|
|
|
async def main():
|
|
agent = Agent("Assistant")
|
|
|
|
# Create underlying session
|
|
underlying_session = SQLAlchemySession.from_url(
|
|
"user-123",
|
|
url="sqlite+aiosqlite:///:memory:",
|
|
create_tables=True
|
|
)
|
|
|
|
# Wrap with encryption
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying_session,
|
|
encryption_key="your-secret-key-here",
|
|
ttl=600 # 10 minutes
|
|
)
|
|
|
|
result = await Runner.run(agent, "Hello", session=session)
|
|
print(result.final_output)
|
|
|
|
if __name__ == "__main__":
|
|
asyncio.run(main())
|
|
```
|
|
|
|
## 設定
|
|
|
|
### 暗号化キー
|
|
|
|
暗号化キーには、Fernet キーまたは任意の文字列を指定できます。
|
|
|
|
```python
|
|
from agents.extensions.memory import EncryptedSession
|
|
|
|
# Using a Fernet key (base64-encoded)
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying_session,
|
|
encryption_key="your-fernet-key-here",
|
|
ttl=600
|
|
)
|
|
|
|
# Using a raw string (will be derived to a key)
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying_session,
|
|
encryption_key="my-secret-password",
|
|
ttl=600
|
|
)
|
|
```
|
|
|
|
### TTL (有効期間)
|
|
|
|
暗号化されたアイテムが有効であり続ける期間を設定します。
|
|
|
|
```python
|
|
# Items expire after 1 hour
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying_session,
|
|
encryption_key="secret",
|
|
ttl=3600 # 1 hour in seconds
|
|
)
|
|
|
|
# Items expire after 1 day
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying_session,
|
|
encryption_key="secret",
|
|
ttl=86400 # 24 hours in seconds
|
|
)
|
|
```
|
|
|
|
## さまざまなセッションタイプでの使用
|
|
|
|
### SQLite セッションでの使用
|
|
|
|
```python
|
|
from agents import SQLiteSession
|
|
from agents.extensions.memory import EncryptedSession
|
|
|
|
# Create encrypted SQLite session
|
|
underlying = SQLiteSession("user-123", "conversations.db")
|
|
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying,
|
|
encryption_key="secret-key"
|
|
)
|
|
```
|
|
|
|
### SQLAlchemy セッションでの使用
|
|
|
|
```python
|
|
from agents.extensions.memory import EncryptedSession, SQLAlchemySession
|
|
|
|
# Create encrypted SQLAlchemy session
|
|
underlying = SQLAlchemySession.from_url(
|
|
"user-123",
|
|
url="postgresql+asyncpg://user:pass@localhost/db",
|
|
create_tables=True
|
|
)
|
|
|
|
session = EncryptedSession(
|
|
session_id="user-123",
|
|
underlying_session=underlying,
|
|
encryption_key="secret-key"
|
|
)
|
|
```
|
|
|
|
!!! warning "高度なセッション機能"
|
|
|
|
`EncryptedSession` を `AdvancedSQLiteSession` のような高度なセッション実装と使用する場合は、次の点に注意してください。
|
|
|
|
- メッセージ内容が暗号化されるため、`find_turns_by_content()` のようなメソッドは効果的に動作しません
|
|
- コンテンツベースの検索は暗号化されたデータに対して実行されるため、有効性が制限されます
|
|
|
|
|
|
|
|
## キー導出
|
|
|
|
EncryptedSession は HKDF (HMAC-based Key Derivation Function) を使用して、セッションごとに一意の暗号化キーを導出します。
|
|
|
|
- **マスターキー**: 提供された暗号化キー
|
|
- **セッションソルト**: セッション ID
|
|
- **情報文字列**: `"agents.session-store.hkdf.v1"`
|
|
- **出力**: 32 バイトの Fernet キー
|
|
|
|
これにより、次のことが保証されます。
|
|
- 各セッションに一意の暗号化キーがあります
|
|
- マスターキーがなければキーを導出できません
|
|
- セッションデータを異なるセッション間で復号できません
|
|
|
|
## 自動期限切れ
|
|
|
|
アイテムが TTL を超えると、取得時に自動的にスキップされます。
|
|
|
|
```python
|
|
# Items older than TTL are silently ignored
|
|
items = await session.get_items() # Only returns non-expired items
|
|
|
|
# Expired items don't affect session behavior
|
|
result = await Runner.run(agent, "Continue conversation", session=session)
|
|
```
|
|
|
|
## API リファレンス
|
|
|
|
- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - メインクラス
|
|
- [`Session`][agents.memory.session.Session] - ベースセッションプロトコル |