easyjwt 0.1.1

[1]：准确地说，创建令牌的类的名称必须 与正在验证的类的名称相同。这个类名包含在每个令牌中 由easyjwt在特殊索赔中创建

编码算法

easyjwt创建的令牌在默认情况下使用hs256算法进行编码。如果你想用不同的算法， 您可以在令牌类的定义中指定此算法。

fromeasyjwtimportAlgorithmfromeasyjwtimportEasyJWTclassMySuperSimpleJWT(EasyJWT):# Use the HS512 algorithm.algorithm=Algorithm.HS512# The usual definition of the token's claim set ...

如果您以前用token类创建了令牌，以后想更改新令牌的算法， 您应该告诉easyjwt仍然使用以前的算法来解码令牌。否则，使用旧的 无法验证您的代码版本！

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

您可以在 API文档

可选声明

您在token类的\u init\u方法中指定的所有声明都是必需的，这两个声明都用于创建此 类和用于验证令牌。如果您希望其中一些声明是可选的（用于创建和验证 令牌），您可以覆盖easyjwt的可选声明可信赖的您可以在令牌中重写这个类变量 类以包含可选声明的名称。请注意，您必须包含easyjwt.\u optional\u声明的值 在你们班上。否则，注册的索赔将成为强制性的。

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

注册索赔

easyjwt支持jwt规范的所有注册声明：aud，exp，iat，iss，jti，nbf和sub。 所有这些声明都是可选的。

观众：aud

访问群体标识令牌的接收者，可以是字符串或字符串列表。

您可以使用令牌对象的属性audience为令牌设置访问群体。这个属性将 创建令牌时自动映射到aud声明。

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

要使用访问群体验证令牌，必须将至少一个访问群体值传递给easyjwt的verify方法。 否则，验证将失败，并出现invalidaudienceerror异常。经过验证，令牌是 访问群体将设置在访问群体属性上。

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

有效期：exp

过期日期指定令牌有效的时间。如果具有到期日期的令牌在其 过期日期已过，令牌将无效。

您可以使用属性expiration_date将令牌的到期日期设置为datetime对象。这个 创建令牌时，属性将自动映射到exp声明。请注意，必须指定 UTC格式的到期日。

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

当使用到期日期验证令牌时，easyjwt会自动检查到期日期是否已过。如果这样 在这种情况下，验证将失败，并出现expiredtokenerror异常。经过验证，令牌是 过期日期将在UTC中的过期日期属性上设置为日期时间对象。

发布时间：IAT

颁发日期指定令牌的创建时间。

创建令牌时，此声明将自动设置为当前时间。如果你想改变 发布日期，您可以将datetime对象（在UTC中）传递给easyjwt的create 方法：

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

使用"颁发日期"验证令牌后，其"颁发日期"将在"颁发日期"属性上设置。

发行人：iss

颁发者标识令牌的创建者。

您可以使用token对象的issuer属性设置令牌的颁发者。这个属性将 创建令牌时自动映射到iss声明。

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

要使用颁发者验证令牌，必须将令牌中指定的颁发者传递给easyjwt的verify方法。 否则，验证将失败，并出现异常。验证后，令牌的颁发者 将在issuer属性上设置。

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

jwt id:jti

jwt id是令牌的标识符。每个令牌都必须是唯一的。

您可以使用token对象的jwt_id属性设置令牌的jwt id。这个属性将 创建令牌时自动映射到jti声明

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

使用jwt id验证令牌后，将在jwt id属性上设置此id。

请注意，easyjwt没有核实这一索赔。您有责任在验证令牌之后验证它，如果 您需要此验证。

不早于：nbf

not before日期指定令牌无效的时间。如果一个带n的代币日期之前的OT是 在到达"不早于"日期之前验证，令牌将无效。

您可以使用datetime对象的属性not_before_date为令牌设置不早于日期。这个属性 将在创建令牌时自动映射到nbf声明。请注意，必须指定不早于日期 在UTC中，

fromeasyjwtimportEasyJWT# Define the claims of your token.classMySuperSimpleJWT(EasyJWT):def__init__(self,key):super().__init__(key)# Define a claim `name`.self.name=None# Create a token with some values.token_object=MySuperSimpleJWT('Super secret key')token_object.name='Zaphod Beeblebrox'token=token_object.create()# Verify the created token.verified_token_object=MySuperSimpleJWT.verify(token,'Super secret key')assertverified_token_object.name=='Zaphod Beeblebrox'

当使用非早于日期验证令牌时，easyjwt会自动检查是否已达到非早于日期。如果 情况并非如此，验证将失败，并出现UnmatureTokenerror异常。在核实之后， token's not before date将在UTC中的not\u before\u date属性上设置为datetime对象。

主题：sub

主题指定令牌的主题。

您可以使用令牌对象的subject属性设置令牌的主题。这个属性将 创建令牌时自动映射到子声明。

python -m pip install easyjwt

使用主题验证令牌后，将在主题属性上设置此主题。

请注意，easyjwt没有核实这一索赔。您有责任在验证令牌之后验证它，如果 您需要此验证。

未来想法

• 允许在没有颁发日期的情况下创建令牌。
• 添加模式以接受任意声明，并根据需要创建相应的属性。
• 允许指定函数在创建令牌之前和验证令牌之后打包和解包声明值， 分别。

致谢

easyjwt只是josépadilla的一个简单易用的抽象层，它位于pyjwt库周围。 它完成了根据jwt规范创建和验证令牌的实际工作。没有他的工作， 不可能轻松工作。

许可证

easyjwt由bastian meyer开发 <；bastian@bastianmeyer.eu>；并根据 麻省理工学院许可证。有关详细信息，请参见附加的许可证文件。

标签：

• the
• key
• name
• token
• web
• json
• 声明
• object

欢迎加入QQ群-->： 979659372

推荐PyPI第三方库

• blood-donors-director

  一个维护献血者数据库的web应用程序

• ace-api

  分析相关引擎（ace）api python绑定。

• wt.pygardena

  连接到Garena Smart的库

• markdown-checklists

  标记清单的分叉：带有复选框的任务列表的python标记扩展

• Highton

  高层python库

• django_scim

  用于django的scim 2.0提供程序规范的部分实现。

• sphinxcontrib-fulltoc

  在sphinx html侧边栏中包含完整的目录

• pytest-finer-verdicts

  将非断言失败视为测试错误的pytest插件。

• holdmybeer

  将库存管理形式化为产品桶。

• django-replace

  Jango更换过滤器

• squawk

  静态文件的sql查询工具和库

• scipion-em-topaz

  黄玉可用于西比昂。

• examplepkg

  一个小的示例包

• free

  把你自己从机长手中解放出来！

• pomodoro-calculator

  一个漂亮的命令行工具，用来计算两个时间点之间可用的pomodori数量。