pg_session_jwt

使用JWT进行会话认证

概览

扩展包名版本分类许可证语言
pg_session_jwt0.4.0SECApache-2.0Rust
ID扩展名BinLibLoadCreateTrustReloc模式
7040pg_session_jwtauth
相关扩展pgjwt pgaudit pgsodium supabase_vault anon

manual updated pgrx by Vonng

版本

类型仓库版本PG 大版本包名依赖
EXTPIGSTY0.4.01817161514pg_session_jwt-
RPMPIGSTY0.4.01817161514pg_session_jwt_$v-
DEBPIGSTY0.4.01817161514postgresql-$v-pg-session-jwt-
OS / PGPG18PG17PG16PG15PG14
el8.x86_64
el8.aarch64
el9.x86_64
el9.aarch64
el10.x86_64
el10.aarch64
d12.x86_64
d12.aarch64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
d13.x86_64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
d13.aarch64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
u22.x86_64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
u22.aarch64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
u24.x86_64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
u24.aarch64
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0
PIGSTY 0.4.0

构建

您可以使用 pig build 命令构建 pg_session_jwt 扩展的 RPM / DEB 包:

pig build pkg pg_session_jwt         # 构建 RPM / DEB 包

安装

您可以直接安装 pg_session_jwt 扩展包的预置二进制包,首先确保 PGDGPIGSTY 仓库已经添加并启用:

pig repo add pgsql -u          # 添加仓库并更新缓存

使用 pig 或者是 apt/yum/dnf 安装扩展:

pig install pg_session_jwt;          # 当前活跃 PG 版本安装
pig ext install -y pg_session_jwt -v 18  # PG 18
pig ext install -y pg_session_jwt -v 17  # PG 17
pig ext install -y pg_session_jwt -v 16  # PG 16
pig ext install -y pg_session_jwt -v 15  # PG 15
pig ext install -y pg_session_jwt -v 14  # PG 14
dnf install -y pg_session_jwt_18       # PG 18
dnf install -y pg_session_jwt_17       # PG 17
dnf install -y pg_session_jwt_16       # PG 16
dnf install -y pg_session_jwt_15       # PG 15
dnf install -y pg_session_jwt_14       # PG 14
apt install -y postgresql-18-pg-session-jwt   # PG 18
apt install -y postgresql-17-pg-session-jwt   # PG 17
apt install -y postgresql-16-pg-session-jwt   # PG 16
apt install -y postgresql-15-pg-session-jwt   # PG 15
apt install -y postgresql-14-pg-session-jwt   # PG 14

创建扩展

CREATE EXTENSION pg_session_jwt;

用法

pg_session_jwt: PostgreSQL 的 JWT 会话管理

pg_session_jwt 通过 JWT 处理认证会话。配置 JWK 后验证 JWT 真实性;无 JWK 时回退到兼容 PostgREST 的 request.jwt.claims

CREATE EXTENSION pg_session_jwt;

模式1:JWK 验证

在连接时通过 libpq 选项设置 JWK:

export PGOPTIONS="-c pg_session_jwt.jwk=$MY_JWK"

在会话中使用:

SELECT auth.init();                        -- 使用 JWK 初始化
SELECT auth.jwt_session_init('eyJ...');    -- 设置并验证 JWT
SELECT auth.user_id();                     -- 获取 'sub' 声明
SELECT auth.session();                     -- 获取完整 JWT 载荷(JSONB)

模式2:PostgREST 兼容(无 JWK)

开箱即用适配 PostgREST,无需初始化:

SELECT auth.user_id();   -- 从 request.jwt.claims 返回 'sub'
SELECT auth.session();   -- 返回完整声明(JSONB)

函数

函数返回类型描述
auth.init()void使用 JWK 初始化会话
auth.jwt_session_init(jwt text)void设置并验证 JWT
auth.session()jsonb获取 JWT 载荷或回退声明
auth.jwt()jsonbauth.session() 的别名
auth.user_id()text获取 sub 声明
auth.uid()uuid获取 sub 作为 UUID(或 NULL)

配置

参数描述
pg_session_jwt.jwk用于 JWT 验证的 JWK(在启动或连接时设置)
pg_session_jwt.audit_log启用审计日志(on/off

RLS 示例

CREATE POLICY user_isolation ON my_table
    USING (user_id = auth.user_id());

最后修改 2026-03-14: update extension metadata (953cbd0)