1. 程式人生 > >第1章 發現端點(Discovery Endpoint) - IdentityModel 中文文檔(v1.0.0)

第1章 發現端點(Discovery Endpoint) - IdentityModel 中文文檔(v1.0.0)

cep 中文 情況 res .com errortype 服務器 本地 tst

OpenID Connect發現端點的客戶端庫作為httpclient的擴展方法提供。該GetDiscoveryDocumentAsync方法返回一個DiscoveryResponse對象,該對象具有發現文檔的各種元素的強類型和弱類型訪問器。

在訪問文檔內容之前,應始終檢查IsErrorError屬性。

例:

var client = new HttpClient();

var disco = await client.GetDiscoveryDocumentAsync("https://demo.identityserver.io");
if (disco.IsError) throw new Exception(disco.Error);

可以使用以下屬性訪問標準元素:

var tokenEndpoint = disco.TokenEndpoint;
var keys = disco.KeySet.Keys;

自定義元素(或標準屬性未涵蓋的元素)可以像這樣訪問:

// returns string or null
var stringValue = disco.TryGetString("some_string_element");

// return a nullable boolean
var boolValue = disco.TryGetBoolean("some_boolean_element");

// return array (maybe empty)
var arrayValue = disco.TryGetStringArray("some_array_element");

// returns JToken
var rawJson = disco.TryGetValue("some_element);

1.1 發現政策

默認情況下,發現響應在返回到客戶端之前已經過驗證,驗證包括:

  • 強制使用HTTPS(localhost地址除外)
  • 強制發行人與當局匹配
  • 強制協議端點與權限位於同一DNS名稱上
  • 強制執行密鑰集的存在

可以使用DiscoveryPolicy類修改所有標準驗證規則,例如禁用頒發者名稱檢查:

var disco = await client.GetDiscoveryDocumentAsync(new DiscoveryDocumentRequest
{
    Address = "https://demo.identityserver.io",
    Policy =
    {
        ValidateIssuerName = false
    }
});

策略沖突錯誤會將DiscoveryResponse上的ErrorType屬性設置為PolicyViolation

1.2 緩存發現文檔

您應該定期更新發現文檔的本地副本,以便能夠對服務器上的配置更改作出響應。這對於使用自動旋轉鍵進行良好的播放尤其重要。

DiscoveryCache類可以幫助你。

以下代碼將設置緩存,在第一次需要時檢索文檔,然後將其緩存24小時:

var cache = new DiscoveryCache("https://demo.identityserver.io");

然後,您可以像這樣訪問文檔:

var disco = await cache.GetAsync();
if (disco.IsError) throw new Exception(disco.Error);

您可以使用該CacheDuration屬性指定緩存持續時間,也可以通過將DiscoveryPolicy傳遞給構造函數來指定自定義發現策略。

1.2.1 緩存和HttpClient實例

默認情況下,發現緩存將在HttpClient每次訪問發現端點時創建新實例。您可以通過兩種方式修改此行為,方法是將預先創建的實例傳入構造函數,或者通過提供將HttpClient在需要時返回的函數。

以下代碼將在DI中設置發現緩存,並將使用HttpClientFactory以創建客戶端:

services.AddSingleton<IDiscoveryCache>(r =>
{
    var factory = r.GetRequiredService<IHttpClientFactory>();
    return new DiscoveryCache(Constants.Authority, () => factory.CreateClient());
});

github地址

第1章 發現端點(Discovery Endpoint) - IdentityModel 中文文檔(v1.0.0)