ID4ME协议的Python客户端库-依赖方端。参见：https://id4me.org
id4me-rp-client的Python项目详细描述
ID4ME RP客户端
id4me协议的python依赖方客户端库。 有关协议的详细信息，请访问：https://id4me.org
库提供依赖方功能，用于身份验证和身份代理的声明请求。
规范参考
https://gitlab.com/ID4me/documentation/blob/master/id4ME%20Technical%20Specification.adoc
- 版本：1.0
- 版次：02
安装
pip install id4me-rp-client
用法
注册客户并向身份认证机构授权
fromid4me_rp_clientimport*# these imports are just needed in this examplefrombuiltinsimportinputimportjsonregistrations=dict()# a routine to save client registration at authoritydefsave_authority_registration(auth_name,auth_content):registrations[auth_name]=auth_contentpass# a routine to load client registration at authoritydefload_authority_registration(auth_name):returnregistrations[auth_name]# create client object with basic parameters of your appclient=ID4meClient(get_client_registration=load_authority_registration,save_client_registration=save_authority_registration,app_type=OIDCApplicationType.web,validate_url='https://dynamicdns.domainconnect.org/ddnscode',client_name='Foo app',logo_url='https://upload.wikimedia.org/wikipedia/commons/7/76/Foobar2000_logo_2014.png',policy_url='https://foo.com/policy',tos_url='https://foo.com/tos',private_jwks_json=ID4meClient.generate_new_private_keys_set())try:# make a discovery of identity authority and register if needed# find_authority and save_authority are optional, but when missing client will be registered each time anewctx=client.get_rp_context(id4me='id200.connect.domains')# get a link to login routinelink=client.get_consent_url(ctx,claimsrequest=ID4meClaimsRequest(userinfo_claims={OIDCClaim.name:ID4meClaimRequestProperties(reason='To call you by name'),OIDCClaim.email:ID4meClaimRequestProperties(essential=True,reason='To be able to contact you'),OIDCClaim.email_verified:ID4meClaimRequestProperties(reason='To know if your E-mail was verified'),}))print('Please open the link:\n{}'.format(link))# Normally code will arrive as query param on client.validateUrlcode=input('Please enter code: ')# Get ID tokenclient.get_idtoken(context=ctx,code=code)# Get User Infouserinfo=client.get_user_info(context=ctx)print('User Info:\n{}'.format(json.dumps(userinfo,sort_keys=True,indent=4)))exceptID4meExceptionase:print('Exception: {}'.format(e))
输出：
Resolving "_openid.id200.connect.domains."
Checking TXT record "v=OID1;iss=id.test.denic.de;clp=identityagent.de"
identity_authority = auth.freedom-id.de
registering with new identity authority (auth.freedom-id.de)
destination = https://auth.freedom-id.de/login?scope=openid&response_type=code&client_id=hmkzay2riyon4&redirect_uri=https%3A//foo.com/validate&login_hint=id200.connect.domains&state=&claims=%7B%22userinfo%22%3A%20%7B%22email_verified%22%3A%20%7B%22reason%22%3A%20%22To%20know%20if%20your%20E-mail%20was%20verified%22%7D%2C%20%22email%22%3A%20%7B%22reason%22%3A%20%22To%20be%20able%20to%20contact%20you%22%2C%20%22essential%22%3A%20true%7D%2C%20%22name%22%3A%20%7B%22reason%22%3A%20%22To%20call%20you%20by%20name%22%7D%7D%7D
Please open the link:
https://auth.freedom-id.de/login?scope=openid&response_type=code&client_id=hmkzay2riyon4&redirect_uri=https%3A//foo.com/validate&login_hint=id200.connect.domains&state=&claims=%7B%22userinfo%22%3A%20%7B%22email_verified%22%3A%20%7B%22reason%22%3A%20%22To%20know%20if%20your%20E-mail%20was%20verified%22%7D%2C%20%22email%22%3A%20%7B%22reason%22%3A%20%22To%20be%20able%20to%20contact%20you%22%2C%20%22essential%22%3A%20true%7D%2C%20%22name%22%3A%20%7B%22reason%22%3A%20%22To%20call%20you%20by%20name%22%7D%7D%7D
Please enter code: >? 9jNXCX9OZ4HQLr2YZWKisw.5mSDkoR-5YJQoTp3f1vuxg
User Info:
{
"aud": "hmkzay2riyon4",
"email": "foo@bar.de",
"email_verified": true,
"exp": 1538762218,
"iat": 1538761918,
"id4me.identifier": "id200.connect.domains",
"id4me.identity": "id200.connect.domains",
"iss": "https://auth.freedom-id.de",
"nbf": 1538761918,
"sub": "uiw3pTRRLVaKJqbnbSwr4EVuhEPTHvRgci91RbhYU2rab/YVDqDmqTKzTVAdDMm+",
"updated_at": 1538564738
}
请求定制索赔
为了请求自定义声明，只需将其名称作为键传入userinfo_claims或id_token_claims。
ID4meClient.get_consent_url方法的参数。
示例
...link=client.get_consent_url(ctx=context,claimsrequest=ID4meClaimsRequest(userinfo_claims={OIDCClaim.email:ID4meClaimRequestProperties(essential=True,reason='Test other confusing reason'),'id4me.custom':ID4meClaimRequestProperties(essential=True,reason='Custom claim reason')}))...
更改日志：
| version | date | changes |
|---|---|---|
| 0.0.22 | 2019-07-29 | BUGFIX: id4me_rp_client.helper not exported to the release library |
| 0.0.21 | 2019-07-29 | BUGFIX: YXDOMAIN case not properly handled BUGFIX: avoid trying to resolve empty domain names BUGFIX: added better handling when state is empty LOGGING: added logging of all exceptions (debug level) |
| 0.0.20 | 2019-05-23 | NEW FEATURE: E-mail address hashing as per spec change proposed in https://gitlab.com/ID4me/documentation/merge_requests/7 MINOR CHANGE: finally deprecated ^{ NEW FEATURE: timeout configurable via NetworkConfig |
| 0.0.19 | 2019-03-24 | TEST: added Kopano to the integration test BUGFIX: leeway to re-register set to 5 minutes istead of 2 hours TEST: added password to mojeid test account |
| 0.0.18 | 2019-03-23 | NEW FEATURE: added support for E-mail like identifiers (just replace @ with .) NEW FEATURE: requesting claims with scope WORKAROUND: accepting token_type as 'Bearer' and 'bearer' BUGFIX: 'tos_uri' assigned properly |
| 0.0.17 | 2019-03-19 | SECURITY FIX: Limited timeouts and size of downloaded data (DOS prevention) SECURITY FIX: Limited recoursion level of distributed claims (DOS prevention) |
| 0.0.16 | 2019-03-11 | MAJOR CHANGE: removed back-compatibility with old _openid record format |
| 0.0.15 | 2019-02-27 | - NEW FEATURE: Automatically re-register expired client registration - explicit parameter to enable/block automatic client registration |
| 0.0.14 | 2019-02-25 | No functional changes. Example code in README fixed |
| 0.0.13 | 2019-02-25 | No functional changes. TEST & EXAMPLE for custom claims added |
| 0.0.12 | 2019-02-21 | BUGFIX: Exception when no encryption used but private key missing |
| 0.0.11 | 2019-02-21 | BUGFIX, error when serializing ID4meContext |
| 0.0.10 | 2019-02-18 | API BREAKING CHANGE: client configuration loading callback moved to client object in order to remove secret data from the ID4meContext which can be in some frameworks sent over cookies |
欢迎加入QQ群-->： 979659372
