zhaolei
6 days ago 5275bbc35b15959c441f1f535a1e5eda96dea822
commit | author | age
4a2e5b 1 <?xml version="1.0"?>
Z 2 <doc>
3     <assembly>
4         <name>Bootstrap.Security.Mvc</name>
5     </assembly>
6     <members>
7         <member name="T:Microsoft.AspNetCore.Builder.AuthenticationExtensions">
8             <summary>
9             BootstrapAdminAuthorization 认证服务扩展类
10             </summary>
11         </member>
12         <member name="M:Microsoft.AspNetCore.Builder.AuthenticationExtensions.UseBootstrapAdminAuthentication(Microsoft.AspNetCore.Builder.IApplicationBuilder,System.Func{System.String,System.Collections.Generic.IEnumerable{System.String}},System.Func{System.String,System.String,System.Collections.Generic.IEnumerable{System.String}},System.Func{System.String,System.Collections.Generic.IEnumerable{System.String}})">
13             <summary>
14             添加 BootstrapAdmin 认证授权服务,内部调用 UseAuthentication
15             </summary>
16             <param name="builder">IApplicationBuilder 实例</param>
17             <param name="userNameAuthHandler">通过用户名称获得角色集合代理方法</param>
18             <param name="urlAuthHandler">通过请求地址获得角色集合代理方法</param>
19             <param name="appAuthHandler">通过用户名称获得应用程序集合代理方法</param>
20         </member>
21         <member name="M:Microsoft.AspNetCore.Builder.AuthenticationExtensions.RetrieveRolesByUserName(System.String)">
22             <summary>
23             通过指定用户名获取授权角色集合
24             </summary>
25             <param name="userName"></param>
26             <returns></returns>
27         </member>
28         <member name="M:Microsoft.AspNetCore.Builder.AuthenticationExtensions.RetrieveRolesByUrl(System.String,System.String)">
29             <summary>
30             通过指定访问地址获取授权角色集合
31             </summary>
32             <param name="url">指定地址</param>
33             <param name="appId">应用程序ID</param>
34             <returns>角色集合</returns>
35         </member>
36         <member name="M:Microsoft.AspNetCore.Builder.AuthenticationExtensions.RetrieveAppsByUserName(System.String)">
37             <summary>
38             通过指定用户名获取授权 App 集合
39             </summary>
40             <param name="userName">用户名</param>
41             <returns>应用程序集合</returns>
42         </member>
43         <member name="M:Microsoft.AspNetCore.Builder.AuthenticationExtensions.AddRoles(System.Security.Claims.ClaimsPrincipal,System.Collections.Generic.IEnumerable{System.String},System.Security.Claims.ClaimsIdentity)">
44             <summary>
45             添加 Claim 到当前用户实例中
46             </summary>
47             <param name="user"></param>
48             <param name="roles"></param>
49             <param name="identity"></param>
50         </member>
51         <member name="T:Microsoft.AspNetCore.Builder.AuthenticationServiceCollectionExtensions">
52             <summary>
53             BootstrapAdminAuthorization 认证服务扩展类
54             </summary>
55         </member>
56         <member name="M:Microsoft.AspNetCore.Builder.AuthenticationServiceCollectionExtensions.AddBootstrapAdminAuthentication(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions},System.Action{Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptions})">
57             <summary>
58             添加 BootstrapAdmin 认证授权服务,内部调用 AddAuthentication
59             </summary>
60             <param name="services">服务容器集合</param>
61             <param name="configuration">IConfiguration 实例</param>
62             <param name="configureOptions">BootstrapAdminAuthenticationOptions 配置回调方法</param>
63             <param name="configureCookies">CookieAuthenticationOptions 配置回调方法</param>
64             <returns>IServiceCollection 服务容器集合</returns>
65         </member>
66         <member name="T:Microsoft.AspNetCore.Builder.HealthChecksBuilderExtensions">
67             <summary>
68             BootstrapAdmin 健康检查扩展类
69             </summary>
70         </member>
5275bb 71         <member name="M:Microsoft.AspNetCore.Builder.HealthChecksBuilderExtensions.UseBootstrapHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString)">
4a2e5b 72             <summary>
Z 73             启用健康检查
74             </summary>
5275bb 75             <param name="app"></param>
4a2e5b 76             <param name="path"></param>
Z 77             <returns></returns>
78         </member>
79         <member name="T:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions">
80             <summary>
81             BootstrapAdminAuthentication 授权框架配置实体类
82             </summary>
83         </member>
84         <member name="P:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions.ApplicationAppName">
85             <summary>
86             获得/设置 应用程序名称 默认 __bd__
87             </summary>
88         </member>
89         <member name="P:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions.ApplicationDiscriminator">
90             <summary>
91             获得/设置 应用程序鉴别器 默认 "BootstrapAdmin"
92             </summary>
93         </member>
94         <member name="P:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions.KeyPath">
95             <summary>
96             获得/设置 登录 Key 物理路径 默认 "..\\keys" (windows) "../keys" macOS/Linux
97             </summary>
98         </member>
99         <member name="P:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions.CookiePath">
100             <summary>
101             获得/设置 Cookie 路径 默认 "/"
102             </summary>
103         </member>
104         <member name="P:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions.CookieDomain">
105             <summary>
106             获得/设置 Cookie Domain 默认 null
107             </summary>
108         </member>
109         <member name="P:Microsoft.AspNetCore.BootstrapAdminAuthenticationOptions.AuthHost">
110             <summary>
111             获得/设置 登录授权应用程序
112             </summary>
113         </member>
114         <member name="T:Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptionsExtensions">
115             <summary>
116             CookieAuthenticationOptions 扩展类
117             </summary>
118         </member>
119         <member name="M:Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptionsExtensions.RebuildRedirectUri(Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptions,System.String,System.String,System.String)">
120             <summary>
121             重写OnRedirectToLogin/OnRedirectToAccessDenied方法
122             </summary>
123             <param name="options">CookieAuthenticationOptions 实例</param>
124             <param name="authHost">授权网站主机头</param>
125             <param name="loginPath">登录地址,默认为 CookieAuthenticationDefaults.LoginPath</param>
126             <param name="accessDeniedPath">拒绝访问地址,默认为 CookieAuthenticationDefaults.AccessDeniedPath</param>
127         </member>
128         <member name="T:Microsoft.AspNetCore.Authorization.AppRequirement">
129             <summary>
130             BootstrapAdmin 应用程序授权要求类
131             </summary>
132         </member>
133         <member name="M:Microsoft.AspNetCore.Authorization.AppRequirement.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Microsoft.AspNetCore.Authorization.AppRequirement)">
134             <summary>
135             处理授权要求方法
136             </summary>
137             <param name="context"></param>
138             <param name="requirement"></param>
139             <returns></returns>
140         </member>
141         <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilderExtensions">
142             <summary>
143             授权扩展操作类
144             </summary>
145         </member>
146         <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilderExtensions.RequireBootstrapAdminAuthorizate(Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder)">
147             <summary>
148             RequireBootstrapAdminAuthorizate 扩展方法
149             </summary>
150             <param name="builder">AuthorizationPolicyBuilder 实例</param>
151             <returns></returns>
152         </member>
153         <member name="T:Microsoft.AspNetCore.Mvc.Filters.BootstrapAdminAuthorizeFilter">
154             <summary>
155             BootstrapAdmin 后台权限认证过滤器
156             </summary>
157         </member>
158         <member name="M:Microsoft.AspNetCore.Mvc.Filters.BootstrapAdminAuthorizeFilter.OnAuthorizationAsync(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)">
159             <summary>
160             异步授权方法
161             </summary>
162             <param name="context">过滤器上下文</param>
163             <returns></returns>
164         </member>
165         <member name="T:Microsoft.AspNetCore.Mvc.Filters.ButtonAuthorizeAttribute">
166             <summary>
167             按钮权限检查过滤器
168             </summary>
169         </member>
170         <member name="P:Microsoft.AspNetCore.Mvc.Filters.ButtonAuthorizeAttribute.Url">
171             <summary>
172             按钮授权所属菜单
173             </summary>
174         </member>
175         <member name="P:Microsoft.AspNetCore.Mvc.Filters.ButtonAuthorizeAttribute.Auth">
176             <summary>
177             按钮授权标识码
178             </summary>
179         </member>
180         <member name="M:Microsoft.AspNetCore.Mvc.Filters.ButtonAuthorizeAttribute.OnActionExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate)">
181             <summary>
182             控制器执行异步调用方法
183             </summary>
184             <param name="context"></param>
185             <param name="next"></param>
186             <returns></returns>
187         </member>
188         <member name="T:Microsoft.Extensions.DependencyInjection.ButtonAuthorizationServicesCollectionExtensions">
189             <summary>
190             按钮授权服务扩展类
191             </summary>
192         </member>
193         <member name="M:Microsoft.Extensions.DependencyInjection.ButtonAuthorizationServicesCollectionExtensions.AddButtonAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Func{System.String,System.String,System.String,System.Boolean})">
194             <summary>
195             添加按钮授权服务到服务容器中
196             </summary>
197             <param name="services">容器服务集合</param>
198             <param name="func">通过用户名获取授权按钮集合回调方法(userName, url, auths) => bool</param>
199             <returns>容器服务集合</returns>
200         </member>
201         <member name="T:Microsoft.Extensions.DependencyInjection.HealthChecksExtensions">
202             <summary>
203             健康检查扩展类
204             </summary>
205         </member>
206         <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksExtensions.AddBootstrapAdminHealthChecks(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder)">
207             <summary>
208             添加 BootstrapAdmin 健康检查
209             </summary>
210             <param name="builder"></param>
211             <returns></returns>
212         </member>
213         <member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
214             <summary>
215             配置文件配置小节映射操作类
216             </summary>
217         </member>
218         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetSection``1(Microsoft.Extensions.Configuration.IConfiguration)">
219             <summary>
220             通过类型获得配置小节 读取顺序 Key > Name > FullName > ProviderAlias
221             </summary>
222             <param name="configuration"></param>
223             <returns></returns>
224         </member>
225         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetOption``1(Microsoft.Extensions.Configuration.IConfiguration,System.Func{``0})">
226             <summary>
227             通过指定 Section 名称 获得配置项类实例
228             </summary>
229             <typeparam name="T"></typeparam>
230             <param name="configuration"></param>
231             <param name="valueFactory">默认值</param>
232             <returns></returns>
233         </member>
234         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetBootstrapAdminAuthenticationOptions(Microsoft.Extensions.Configuration.IConfiguration)">
235             <summary>
236             获得 配置文件中 BootstrapAdminAuthenticationOptions 实例
237             </summary>
238             <param name="configuration"></param>
239             <returns></returns>
240         </member>
241         <member name="T:Bootstrap.Security.Authentication.BootstrapAdminJwtTokenHandler">
242             <summary>
243             BootstrapAdmin JWT 授权操作类
244             </summary>
245         </member>
246         <member name="M:Bootstrap.Security.Authentication.BootstrapAdminJwtTokenHandler.CreateToken(System.String,System.Action{Bootstrap.Security.Authentication.TokenValidateOption})">
247             <summary>
248             通过指定用户名创建 JWT Token
249             </summary>
250             <param name="userName">用户名</param>
251             <param name="configure">Token 配置信息</param>
252             <returns>Json Web Token (JWT)</returns>
253         </member>
254         <member name="T:Bootstrap.Security.Authentication.TokenValidateOption">
255             <summary>
256             JWT Token 配置项
257             </summary>
258         </member>
259         <member name="P:Bootstrap.Security.Authentication.TokenValidateOption.Issuer">
260             <summary>
261             获得/设置 颁发者 默认 BA
262             </summary>
263         </member>
264         <member name="P:Bootstrap.Security.Authentication.TokenValidateOption.Audience">
265             <summary>
266             获得/设置 接受者 默认 api
267             </summary>
268         </member>
269         <member name="P:Bootstrap.Security.Authentication.TokenValidateOption.Expires">
270             <summary>
271             获得/设置 超期时间 默认 5 分钟
272             </summary>
273         </member>
274         <member name="P:Bootstrap.Security.Authentication.TokenValidateOption.SecurityKey">
275             <summary>
276             获得/设置 安全码 默认 BootstrapAdmin-V1.1
277             </summary>
278         </member>
279         <member name="T:Bootstrap.Security.Authorization.DefaultButtonAuthorization">
280             <summary>
281             IButtonAuthorization 内部默认实现类
282             </summary>
283         </member>
284         <member name="M:Bootstrap.Security.Authorization.DefaultButtonAuthorization.#ctor(System.Func{System.String,System.String,System.String,System.Boolean})">
285             <summary>
286             默认构造函数
287             </summary>
288             <param name="func">通过指定用户名获取按钮授权集合回调方法</param>
289         </member>
290         <member name="M:Bootstrap.Security.Authorization.DefaultButtonAuthorization.Authorizate(Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
291             <summary>
292             授权方法
293             </summary>
294             <param name="context">HttpContext 上下文</param>
295             <param name="url">当前请求地址 Url</param>
296             <param name="auths">当前按钮授权字符串键值</param>
297             <returns></returns>
298         </member>
299         <member name="M:Bootstrap.Security.Authorization.DefaultButtonAuthorization.Authorizate(System.Security.Claims.ClaimsPrincipal,System.String,System.String)">
300             <summary>
301             授权方法
302             </summary>
303             <param name="user">当前登录用户实例</param>
304             <param name="url">当前请求地址 Url</param>
305             <param name="authKeys">当前按钮授权字符串键值</param>
306             <returns></returns>
307         </member>
308         <member name="T:Bootstrap.Security.Authorization.IButtonAuthorization">
309             <summary>
310             按钮授权接口
311             </summary>
312         </member>
313         <member name="M:Bootstrap.Security.Authorization.IButtonAuthorization.Authorizate(System.Security.Claims.ClaimsPrincipal,System.String,System.String)">
314             <summary>
315             授权方法
316             </summary>
317             <param name="user">当前登录用户实例</param>
318             <param name="url">当前请求地址 Url</param>
319             <param name="authKeys">当前按钮授权字符串键值</param>
320             <returns></returns>
321         </member>
322         <member name="T:Bootstrap.Security.Mvc.BootstrapAppContext">
323             <summary>
324             BootstrapAdmin 应用程序上下文
325             </summary>
326         </member>
327         <member name="P:Bootstrap.Security.Mvc.BootstrapAppContext.AppId">
328             <summary>
329             获得 当前应用程序配置 appId 值
330             </summary>
331         </member>
332         <member name="P:Bootstrap.Security.Mvc.BootstrapAppContext.Configuration">
333             <summary>
334             获得 当前应用程序 IConfiguration 实例
335             </summary>
336         </member>
337         <member name="P:Bootstrap.Security.Mvc.BootstrapAppContext.ServiceProvider">
338             <summary>
339             获得 当前应用程序容器服务接口实例
340             </summary>
341         </member>
342         <member name="M:Bootstrap.Security.Mvc.BootstrapAppContext.SetConfiguration(Microsoft.Extensions.Configuration.IConfiguration)">
343             <summary>
344             设置当前上下文 IConfiguration 实例
345             </summary>
346             <param name="configuration"></param>
347         </member>
348         <member name="M:Bootstrap.Security.Mvc.BootstrapAppContext.SetProvider(System.IServiceProvider)">
349             <summary>
350             设置 当前上下文容器服务器接口实例
351             </summary>
352             <param name="provider"></param>
353         </member>
354         <member name="T:Bootstrap.Security.Mvc.HealthChecks.EnvironmentCheck">
355             <summary>
356             环境变量健康检查类
357             </summary>
358         </member>
359         <member name="M:Bootstrap.Security.Mvc.HealthChecks.EnvironmentCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">
360             <summary>
361             异步检查方法
362             </summary>
363             <param name="context"></param>
364             <param name="cancellationToken"></param>
365             <returns></returns>
366         </member>
367         <member name="T:Bootstrap.Security.Mvc.HealthChecks.GCHealthCheck">
368             <summary>
369             内存状态检查其
370             </summary>
371         </member>
372         <member name="M:Bootstrap.Security.Mvc.HealthChecks.GCHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">
373             <summary>
374             异步检查方法
375             </summary>
376             <param name="context"></param>
377             <param name="cancellationToken"></param>
378             <returns></returns>
379         </member>
380         <member name="T:Bootstrap.Security.Mvc.HealthChecks.MemoryHealthCheck">
381             <summary>
382             内存检查器
383             </summary>
384         </member>
385         <member name="M:Bootstrap.Security.Mvc.HealthChecks.MemoryHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">
386             <summary>
387             异步检查方法
388             </summary>
389             <param name="context"></param>
390             <param name="cancellationToken"></param>
391             <returns></returns>
392         </member>
393         <member name="T:Bootstrap.Security.Mvc.HealthChecks.NetCoreRuntimeCheck">
394             <summary>
395             NETCore 运行时检查
396             </summary>
397         </member>
398         <member name="M:Bootstrap.Security.Mvc.HealthChecks.NetCoreRuntimeCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">
399             <summary>
400             异步检查方法
401             </summary>
402             <param name="context"></param>
403             <param name="cancellationToken"></param>
404             <returns></returns>
405         </member>
406         <member name="T:Bootstrap.Security.Mvc.TagHelpers.AuthorizateTagHelper">
407             <summary>
408             网页控件授权帮助类
409             </summary>
410         </member>
411         <member name="M:Bootstrap.Security.Mvc.TagHelpers.AuthorizateTagHelper.#ctor(Bootstrap.Security.Authorization.IButtonAuthorization,Microsoft.AspNetCore.Http.IHttpContextAccessor)">
412             <summary>
413             默认构造函数
414             </summary>
415             <param name="authorization">IButtonAuthorization 实例</param>
416             <param name="httpContextAccessor">IHttpContextAccessor 实例</param>
417         </member>
418         <member name="P:Bootstrap.Security.Mvc.TagHelpers.AuthorizateTagHelper.AuthorizationServices">
419             <summary>
420             获得 按钮授权服务
421             </summary>
422         </member>
423         <member name="P:Bootstrap.Security.Mvc.TagHelpers.AuthorizateTagHelper.HttpContext">
424             <summary>
425             获得 请求上线文
426             </summary>
427         </member>
428         <member name="P:Bootstrap.Security.Mvc.TagHelpers.AuthorizateTagHelper.AuthKey">
429             <summary>
430             获得/设置 授权键值
431             </summary>
432         </member>
433         <member name="M:Bootstrap.Security.Mvc.TagHelpers.AuthorizateTagHelper.Process(Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext,Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput)">
434             <summary>
435             HTML处理方法
436             </summary>
437             <param name="context">HTML Tag 上下文</param>
438             <param name="output">Tag 内容流</param>
439         </member>
440         <member name="M:System.OSPlatformPathExtenstions.GetOSPlatformPath(System.String)">
441             <summary>
442             获得 当前操作系统目录分隔符的路径
443             </summary>
444             <param name="originalString">原始路径字符串</param>
445             <returns></returns>
446         </member>
447     </members>
448 </doc>