暗号化セッション
EncryptedSession は、任意のセッション実装に対して透過的な暗号化を提供し、自動的に古いアイテムの有効期限切れを処理して会話データを保護します。
機能
- 透過的な暗号化: 任意のセッションを Fernet 暗号化でラップします
- セッションごとの鍵: HKDF による鍵導出でセッションごとに一意の暗号鍵を使用します
- 自動有効期限: TTL が切れた古いアイテムは静かにスキップされます
- ドロップイン置き換え: 既存の任意のセッション実装で動作します
インストール
暗号化セッションには encrypt 追加機能が必要です:
クイックスタート
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 キーでも、任意の文字列でも使用できます:
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(有効期間)
暗号化されたアイテムが有効な期間を設定します:
# 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 セッションでの使用
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 セッションでの使用
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"
)
高度なセッション機能
EncryptedSession を AdvancedSQLiteSession のような高度なセッション実装と併用する場合、次の点に注意してください:
- メッセージ内容が暗号化されるため、
find_turns_by_content()のようなメソッドは効果的に機能しません - コンテンツベースの検索は暗号化データ上で動作するため、その有効性が制限されます
鍵導出
EncryptedSession は HKDF(HMAC-based Key Derivation Function)を使用して、セッションごとに一意の暗号鍵を導出します:
- マスターキー: 提供された暗号鍵
- セッションソルト: セッション ID
- Info 文字列:
"agents.session-store.hkdf.v1" - 出力: 32 バイトの Fernet キー
これにより次のことが保証されます: - 各セッションには一意の暗号鍵があります - マスターキーなしに鍵を導出することはできません - セッション間でデータを復号することはできません
自動有効期限
アイテムが TTL を超えた場合、取得時に自動的にスキップされます:
# 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- メインクラスSession- ベースセッションプロトコル