keycloak~token有效期与session有效期

标签：有效期过期 max refresh access token session

一 refresh_token刷新access_token

Keycloak会话管理中，获取到accessToken和refreshToken后，基于accessToken交换用户数据或者参与KeycloakAPI的请求，当accessToken过期的时候，可使用refreshToken去交换新的accessToken和refreshToken。

这块根据之前的refresh_token就得到了一个新的token对象

refresh_token和access_token有效期配置

refresh_token的有效期一般比access_token的长，这也就是通过refresh_token来换取新的access_token的一个前提，下面来配置一个这两个token的超时时间。
refresh_token超时时间refresh_expires_in，在realms settings中，选择tokens进行配置，对SSO Session Max进行设置

access_token超时时间expires_in,在realms settings中，选择tokens进行配置，对Access Token Lifespan进行设置。

这个用户会话，对应的sessionId(session_state)可以在浏览器cookie中找到，或者在kc管理后台的用户-》会话中查看，这个sessionId被客户端访问，都会刷新这个“开始”时间，和“最后访问”时间，当你的access_token过期后，你通过refresh_token去刷新access_token时，这个“最后访问”时间也会更新，如图

如果用户访问资源，在token过期，而refresh_token(sso session max)未过期时，你可以通过refresh_token来获取新的token，这时会有新的会话产生；但如果refresh_token也过期时，它将跳转到登录页，从新进行认证，会话也就被删除了。

三 refresh_token过期时间的配置

领域设置->Tokens中，有四个选项用来控制refresh_token的超时时间

SSO Session Idle
SSO Session Max
Client Session Idle
Client Session Max

下图的4个选项，配置是有问题的，正确的配置应该是最长时间大于空闲时间，下面配置无意义，这时有效性使用4个选项中最小的值【sso会话空闲时间，sso会话最长时间，client session Idle和client session Max】

如果正常配置的话，当空闲时间和最长时间不相同时，真实的refresh_token_expire时间将取决于client Session Idle的值，如下配置

当refresh_token到期之后到达（ session max的时间），session就失效了，而它并不会立即清除，它会交给keycloak进行维护，最长是session max时间后自动清除，而用户如果在这个时间之前进行refresh_token时，会提示token是不活动的，这时会话也会也被清空，表示令牌过期了，如下面两张图：

当session idle和session max不相同时(sso session max和client session max)，用户的会话会在sso session max到期时删除，而sso session max是全局的，不能在客户端单独配置，一个会话是在什么时间被系统回收，主要由以下6个参数决定，SSO Session Max和Client Sesssion Max我们设置一个即可，它在keycloak后台清理session时会以最长的为准，而当session达到session idle时间时，如果用户主动刷新token，session也会被主动删除，不会等session max时间达了再删。

四 Session Idle和Session Max的作用

会话的空闲时间(Idle)，是指在多长时间之内没有使用refresh_token进行刷新，这个会话(session_state)就过期，无法再直接用refresh_token去换新的token了，这时用户就需要重新回到登录页，完成新的认证；这主要针对长时间不操作的用户，kc需要让它重新完成用户名密码的确认。

注意：如果开启了“记住我”这个功能，因为如果开启“记住我”功能之后，你的会话空闲时间等于“记住我空闲时间”，你的”sso session idle”配置将失效，如果记住我配置了最大时间和空闲时间，那么token的生成和校验都将使用记住我的时间，如图keycloak14.0.0.-services里AuthenticationManage.isSessionValid的源码。

【session idle在判断上有2分钟的误差，主要考虑DC集群的数据同步，比如idle有效期5分钟，那么真正过期就是5+2为7分钟】当到7分钟后，你获取session是否在线时，结果会返回false.

上面代码中，isSessionValid方法会在验证token和刷新token时都会进行执行，我们如果希望将session idle和session max去正确使用，还需要修改kc源代码中的org.keycloak.protocol.oidc
.TokenManager.refreshAccessToken()方法中的代码,将verifyRefreshToken方法参数中的checkExpiration改成false，如图：

最后，下图配置了access_token有效期2分钟，refresh_token最长30天，会话空闲为7天；配置的作用为：用户每2分钟access_token会过期，然后用户通过refresh_token去换新的access_token，如果用户7天没有换token，这个会话就过期，如果会话已经产生了30天，则会话也过期，用户就会返回登录页，重新认证。

事实上，当session idle 和session max相等时，你的refresh_token的过期时间会一直递减，从第一次申请这个refresh_token开始，这个过期时间就固定了，它和你换新token是无关系的；但如果session idle和 session max不相等时（max>idle），你每换新token，你的新换的refresh_token的过期时间都从头开始算，它的大小等于session idle的大小，这也是你在session idle时间内没有去刷新token而会话就会过期的原因，请注意：我们要用新换回的refresh_token把之前的refresh_token也替换掉，因为老的已经过期了。