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