-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WIP reconfigure with better locations for generated code
- Loading branch information
1 parent
3e3a4c7
commit 56639ce
Showing
15 changed files
with
2,362 additions
and
2,373 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,4 +14,6 @@ log.txt | |
| /xxobj/ | ||
| /xxxobj/ | ||
|
|
||
| node_modules | ||
| node_modules | ||
|
|
||
| /api-generated/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
242 changes: 242 additions & 0 deletions
242
docs/api/dot-net/ToSic.Sxc.WebApi.SecureEndpointAttribute.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <!-- 2sxc docs --> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Class SecureEndpointAttribute | 2sxc 18 for Dnn and Oqtane </title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="Class SecureEndpointAttribute | 2sxc 18 for Dnn and Oqtane "> | ||
|
|
||
| <link rel="icon" href="../../assets/favicon.ico"> | ||
| <link rel="stylesheet" href="../../public/docfx.min.css"> | ||
| <link rel="stylesheet" href="../../public/main.css"> | ||
| <meta name="docfx:navrel" content="../../toc.html"> | ||
| <meta name="docfx:tocrel" content="toc.html"> | ||
|
|
||
| <meta name="docfx:rel" content="../../"> | ||
|
|
||
|
|
||
| <meta name="docfx:docurl" content="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=ToSic_Sxc_WebApi_SecureEndpointAttribute.md&value=---%0Auid%3A%20ToSic.Sxc.WebApi.SecureEndpointAttribute%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> | ||
| <meta name="loc:inThisArticle" content="In this article"> | ||
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
| <meta name="loc:searchNoResults" content="No results for "{query}""> | ||
| <meta name="loc:tocFilter" content="Filter by title"> | ||
| <meta name="loc:nextArticle" content="Next"> | ||
| <meta name="loc:prevArticle" content="Previous"> | ||
| <meta name="loc:themeLight" content="Light"> | ||
| <meta name="loc:themeDark" content="Dark"> | ||
| <meta name="loc:themeAuto" content="Auto"> | ||
| <meta name="loc:changeTheme" content="Change theme"> | ||
| <meta name="loc:copy" content="Copy"> | ||
| <meta name="loc:downloadPdf" content="Download PDF"> | ||
|
|
||
| <script src="https://cdn.jsdelivr.net/npm/@fancyapps/[email protected]/dist/fancybox/fancybox.umd.js"></script> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fancyapps/[email protected]/dist/fancybox/fancybox.css"> | ||
|
|
||
|
|
||
| </head> | ||
|
|
||
| <script type="module" src="./../../public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
| <script async src="https://www.googletagmanager.com/gtag/js?id=GTM-PH2TVNW"></script> | ||
| <script> | ||
| window.dataLayer = window.dataLayer || []; | ||
| function gtag() { dataLayer.push(arguments); } | ||
| gtag('js', new Date()); | ||
| gtag('config', 'GTM-PH2TVNW'); | ||
| </script> | ||
|
|
||
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="../../index.html"> | ||
| <img id="logo" class="svg" src="../../assets/logos/vcurrent/50.png" alt=""> | ||
|
|
||
| </a> | ||
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
|
|
||
|
|
||
|
|
||
| <form class="search" role="search" id="search"> | ||
| <i class="bi bi-search"></i> | ||
| <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search"> | ||
|
|
||
| <a class="btn btn-sm border-0 text-nowrap version-button" xstyle="padding: 10px 0 0 0; width: 25px" href="https://go.2sxc.org/docs-versions" target="_blank"> | ||
| v18 <i class="bi bi-caret-down-fill fs-6"></i> | ||
| </a> | ||
| </form> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="ToSic.Sxc.WebApi.SecureEndpointAttribute"> | ||
|
|
||
|
|
||
|
|
||
| <h1 id="ToSic_Sxc_WebApi_SecureEndpointAttribute" data-uid="ToSic.Sxc.WebApi.SecureEndpointAttribute" class="text-break"> | ||
| Class SecureEndpointAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/2sic/2sxc/blob/develop/Src/Sxc/ToSic.Sxc.WebApi/WebApi/SecureEndpoint/SecureEndpointAttributeNetFull.cs/#L29"><i class="bi bi-code-slash"></i></a> | ||
| </h1> | ||
|
|
||
| <div class="facts text-secondary"> | ||
| <dl><dt>Namespace</dt><dd><a class="xref" href="ToSic.html">ToSic</a>.<a class="xref" href="ToSic.Sxc.html">Sxc</a>.<a class="xref" href="ToSic.Sxc.WebApi.html">WebApi</a></dd></dl> | ||
| <dl><dt>Assembly</dt><dd>ToSic.Sxc.WebApi.dll</dd></dl> | ||
| </div> | ||
|
|
||
| <div class="markdown summary"><p>An ActionFilter attribute that automatically decrypts encrypted POST payloads for Web API endpoints. | ||
| Apply this attribute to a controller or action method to seamlessly handle encrypted incoming POST requests, | ||
| ensuring the decrypted data is available for processing within the action method.</p> | ||
| </div> | ||
| <div class="markdown conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">[PublicApi] | ||
| [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] | ||
| public class SecureEndpointAttribute : ActionFilterAttribute, _Attribute</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritance"> | ||
| <dt>Inheritance</dt> | ||
| <dd> | ||
| <div><span class="xref">object</span></div> | ||
| <div><span class="xref">Attribute</span></div> | ||
| <div><span class="xref">FilterAttribute</span></div> | ||
| <div><span class="xref">ActionFilterAttribute</span></div> | ||
| <div><span class="xref">SecureEndpointAttribute</span></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <dl class="typelist implements"> | ||
| <dt>Implements</dt> | ||
| <dd> | ||
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.interopservices._attribute">_Attribute</a></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 id="ToSic_Sxc_WebApi_SecureEndpointAttribute_remarks">Remarks</h2> | ||
| <div class="markdown level0 remarks"><p>This attribute intercepts POST requests with JSON content, checks for encrypted data, | ||
| and if present, decrypts the payload using the <span class="xref">ToSic.Eav.Security.Encryption.AesHybridCryptographyService</span>. | ||
| It then deserializes the decrypted data into the expected parameter type and replaces the action arguments. | ||
| If the payload is not encrypted, the request content remains unchanged.</p> | ||
| <ul> | ||
| <li>Introduced in version 18.05.</li> | ||
| </ul> | ||
| </div> | ||
|
|
||
|
|
||
| <h2 class="section" id="methods">Methods | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="ToSic_Sxc_WebApi_SecureEndpointAttribute_OnActionExecuting_" data-uid="ToSic.Sxc.WebApi.SecureEndpointAttribute.OnActionExecuting*"></a> | ||
|
|
||
| <h3 id="ToSic_Sxc_WebApi_SecureEndpointAttribute_OnActionExecuting_System_Web_Http_Controllers_HttpActionContext_" data-uid="ToSic.Sxc.WebApi.SecureEndpointAttribute.OnActionExecuting(System.Web.Http.Controllers.HttpActionContext)"> | ||
| OnActionExecuting(HttpActionContext) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/2sic/2sxc/blob/develop/Src/Sxc/ToSic.Sxc.WebApi/WebApi/SecureEndpoint/SecureEndpointAttributeNetFull.cs/#L35"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Occurs before the action method is invoked.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public override void OnActionExecuting(HttpActionContext filterContext)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>filterContext</code> <span class="xref">HttpActionContext</span></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </article> | ||
|
|
||
| <div class="contribution d-print-none"> | ||
| <a href="https://github.com/2sic/2sxc/blob/develop/Src/Sxc/ToSic.Sxc.WebApi/WebApi/SecureEndpoint/SecureEndpointAttributeNetFull.cs/#L29" class="edit-link">Edit this page</a> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
| <div class="container-xxl search-results" id="search-results"></div> | ||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
|
|
||
| <span> | ||
| Made by <a href="https://www.2sic.com">2sic</a> | ||
| with 💖 and | ||
| <a href="https://dotnet.github.io/docfx">docfx</a> | ||
| — | ||
| for <a href="https://2sxc.org">2sxc</a>, | ||
| <a href="https://dnncommunity.org/">Dnn</a> | ||
| and <a href="https://www.oqtane.org/">Oqtane</a> | ||
| — | ||
| see also <a href="">2sxc Github</a> and <a href="https://blazor-cms.org">Blazor CMS</a> | ||
| </span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.