Skip to content

Commit 8f9248c

Browse files
Merge branch 'main' into develop
2 parents a0de2e3 + 2bb5769 commit 8f9248c

4 files changed

Lines changed: 20 additions & 11 deletions

File tree

Images/TabList.png

389 Bytes
Loading

Images/ToolsTab.png

36.4 KB
Loading

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ Stott Security is a free to use module, however if you want to show your support
1616

1717
## Interface
1818

19-
The user interface is split into 7 tabs:
19+
The user interface is split into 8 tabs:
2020

2121
- Tabs 1 to 3 focus on the Content Security Policy.
2222
- Tab 4 focuses on the Cross Origin Resource Sharing functionality.
2323
- Tab 5 focuses on miscellaneous response headers.
2424
- Tab 6 provides you with a preview of the headers the module will generate.
2525
- Tab 7 provides you with the audit history for all changes made within the module.
26+
- Tab 8 provides you with additional tools to import and export settings.
2627

2728
![CSP Settings Tab](/Images/TabList.png)
2829

@@ -87,15 +88,15 @@ Recommendations:
8788

8889
The CSP Violations tab is the forth tab dedicated to managing your Content Security Policy. This tab requires a developer to add the reporting view component to the website (read more below under CSP Reporting). When the plugin receives a report of a violation of the Content Security Policy, it will make a record of the third party source and what directive was violated. This is then presented to the user so that that can see how often a violation is happening and when it last happened. A handy **Create CSP Entry** button allows the user to quickly merge the violated source and directive into the Content Security Policy.
8990

90-
**Updated in version 2.0.0.0 to include source and directive filtering.**
91+
**Updated in version 2.0.0 to include source and directive filtering.**
9192

9293
![CSP Violations Tab](/Images/CspViolationTab.png)
9394

9495
### Cross Origin Resource Sharing
9596

96-
**New in version 2.0.0.0**
97+
**New in version 2.0.0**
9798

98-
The CORS tab is new in version 2.0.0.0 and allows the user to configure the Cross-Origin Resource Sharing headers for the website. This is used to grant permissions to third party websites to consume APIs and content from your website. As trends have moved towards headless and hybrid solutions, controlling your CORS headers can be essential to allowing hybrid solutions to work.
99+
The CORS tab is new in version 2.0.0 and allows the user to configure the Cross-Origin Resource Sharing headers for the website. This is used to grant permissions to third party websites to consume APIs and content from your website. As trends have moved towards headless and hybrid solutions, controlling your CORS headers can be essential to allowing hybrid solutions to work.
99100

100101
![CORS Tab](/Images/CorsTab.png)
101102

@@ -113,7 +114,7 @@ The CORS tab is new in version 2.0.0.0 and allows the user to configure the Cros
113114

114115
The Security Headers tab is a catch all for many simple security headers. Some of these are deprecated by the existance of a Content Security Policy, but may still be required for older browsers which do not support a Content Security Policy.
115116

116-
![CORS Tab](/Images/SecurityHeadersTab1.png)
117+
![Security Headers Tab](/Images/SecurityHeadersTab1.png)
117118

118119
| Setting | Default | Recommended |
119120
|---------|---------|-------------|
@@ -124,15 +125,15 @@ The Security Headers tab is a catch all for many simple security headers. Some
124125

125126
Please note that the X-XSS-Protection header is classed as non-standard and deprecated by the Content Security Policy and in some implementations can introduce vulnerabilities. This option may be removed in future. You can read more here: [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection)
126127

127-
![CORS Tab](/Images/SecurityHeadersTab2.png)
128+
![Security Headers Tab](/Images/SecurityHeadersTab2.png)
128129

129130
| Setting | Default | Recommended |
130131
|---------|---------|-------------|
131132
| Include Cross Origin Embedder Policy (Cross-Origin-Embedder-Policy) | disabled | Requires CORP |
132133
| Include Cross Origin Opener Policy (Cross-Origin-Opener-Policy) | disabled | Same Origin |
133134
| Include Cross Origin Resource Policy (Cross-Origin-Resource-Policy) | disabled | Same Origin |
134135

135-
![CORS Tab](/Images/SecurityHeadersTab3.png)
136+
![Security Headers Tab](/Images/SecurityHeadersTab3.png)
136137

137138
| Setting | Default | Recommended |
138139
|---------|---------|-------------|
@@ -144,7 +145,7 @@ Please note that the X-XSS-Protection header is classed as non-standard and depr
144145

145146
The preview screen will show you the compiled headers that will be returned as part of any GET request. This does not include CORS headers as these vary based on request or may only be exposed as part of a pre-flight request by the browser.
146147

147-
**New in version 2.2.0.0**
148+
**New in version 2.2.0**
148149

149150
![CORS Tab](/Images/PreviewTab.png)
150151

@@ -156,6 +157,14 @@ Please note that this module does not contain any code that clears down the audi
156157

157158
![CORS Tab](/Images/AuditTab.png)
158159

160+
## Tools
161+
162+
The tools tab introduces the ability to import and export your entire configuration. The Export function will provide you with a JSON file of all of your configuration settings. The Import function will require the same JSON file structure and will validate the content of the configuration before applying it.
163+
164+
**New in version 2.6.0**
165+
166+
![Tools Tab](/Images/ToolsTab.png)
167+
159168
## Configuration
160169

161170
After pulling in a reference to the Stott.Security.Optimizely project, you only need to ensure the following lines are added to the startup class of your solution:

src/Stott.Security.Optimizely/Stott.Security.Optimizely.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<TargetFrameworks>net6.0;net8.0</TargetFrameworks>
55
<AddRazorSupportForMvc>true</AddRazorSupportForMvc>
6-
<Version>2.5.0.0</Version>
6+
<Version>2.6.0.0</Version>
77
<RepositoryUrl>https://github.com/GeekInTheNorth/Stott.Security.Optimizely</RepositoryUrl>
88
<PackageProjectUrl>https://github.com/GeekInTheNorth/Stott.Security.Optimizely</PackageProjectUrl>
99
<PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
@@ -14,9 +14,9 @@
1414
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
1515
<RepositoryType>git</RepositoryType>
1616
<PackageReadmeFile>README.md</PackageReadmeFile>
17-
<AssemblyVersion>2.5.0.0</AssemblyVersion>
17+
<AssemblyVersion>2.6.0.0</AssemblyVersion>
1818
<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
19-
<PackageReleaseNotes>Add more options for CSP Violation reporting and improve safety of header manipulation.</PackageReleaseNotes>
19+
<PackageReleaseNotes>Add the ability to import and export settings. Improved performance by reducing DbContext creations by over 95% improving caching of configuration.</PackageReleaseNotes>
2020
<Nullable>enable</Nullable>
2121
</PropertyGroup>
2222

0 commit comments

Comments
 (0)