feat: Enables CORS and JWT configuration for WebApplications in CspApplication tag #973
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,72 @@ | ||
| /// This class validates that CORS headers and allowed origins are configured correctly, | ||
| /// and that JWT authentication is properly set up in the <b><WebApplication></b> configuration section. | ||
| Class Test.PM.Integration.ConfigCorsAndJWTInWebAppTest Extends Test.PM.Integration.Base | ||
|
||
| { | ||
|
|
||
| Parameter CommonPathPrefix As STRING = "cors-rest-apps"; | ||
|
|
||
| Parameter WebAppName As STRING = "/testcors"; | ||
|
|
||
| /// Test.PM.Integration.Uninstall | ||
| Method TestCORSEnabledWebAppViaModule() | ||
| { | ||
| #define NormalizeDirectory(%path) ##class(%File).NormalizeDirectory(%path) | ||
| #define UTRoot ^UnitTestRoot | ||
|
|
||
| set testRoot = $$$NormalizeDirectory($get($$$UTRoot)) | ||
| set moduleDir = $$$NormalizeDirectory(##class(%File).GetDirectory(testRoot)_"/_data/"_..#CommonPathPrefix_"/") | ||
| set moduleFile = ##class(%File).NormalizeFilename("module.xml",moduleDir) | ||
| if ##class(%File).DirectoryExists(moduleFile) { | ||
| do $$$AssertStatusOK(1,"module.xml File exist on "_moduleDir) | ||
| } | ||
| set status = ##class(%IPM.Main).Shell("load "_moduleDir) | ||
| do $$$AssertStatusOK(status,"Loaded "_..#CommonPathPrefix_" module successfully from "_moduleDir) | ||
| do ..VerifyCORSConfiguration() | ||
| do ..VerifyJWTConfiguration() | ||
|
|
||
| set status = ##class(%IPM.Main).Shell("uninstall "_..#CommonPathPrefix) | ||
| do $$$AssertStatusOK(status,"uninstalled "_..#CommonPathPrefix_" module successfully.") | ||
| } | ||
|
|
||
| Method VerifyCORSConfiguration() | ||
| { | ||
| new $namespace | ||
| set $namespace = "%SYS" | ||
| set status = ##class(Security.Applications).Get(..#WebAppName, .props) | ||
| do $$$AssertStatusOK(status,"Web applciation "_..#WebAppName_" created scuccessfully") | ||
| if $data(props("CorsAllowlist"),corsAllowlist) { | ||
| do $$$AssertStatusOK(1,"CorsAllowlist values are defined") | ||
| do $$$LogMessage(corsAllowlist) | ||
| } | ||
| if $data(props("CorsCredentialsAllowed"),corsAllow) { | ||
| do $$$AssertStatusOK(1,"CorsCredentialsAllowed values are defined") | ||
| do $$$LogMessage(corsAllow) | ||
| } | ||
| if $data(props("CorsHeadersList"),corsHeadersList) { | ||
| do $$$AssertStatusOK(1,"CorsHeadersList values are defined") | ||
| do $$$LogMessage(corsHeadersList) | ||
| } | ||
| } | ||
|
|
||
| Method VerifyJWTConfiguration() | ||
| { | ||
| new $namespace | ||
| set $namespace = "%SYS" | ||
| set status = ##class(Security.Applications).Get(..#WebAppName, .props) | ||
| do $$$AssertStatusOK(status,"Web applciation "_..#WebAppName_" created scuccessfully") | ||
| do $$$LogMessage("Validating JWT configuration") | ||
| if $data(props("JWTAccessTokenTimeout"),JWTAccessTokenTimeout) { | ||
| do $$$AssertStatusOK(1,"JWTAccessTokenTimeout value is defined") | ||
| do $$$LogMessage(JWTAccessTokenTimeout) | ||
| } | ||
| if $data(props("JWTAuthEnabled"),JWTAuthEnabled) { | ||
| do $$$AssertStatusOK(1,"JWTAuthEnabled value is defined") | ||
| do $$$LogMessage(JWTAuthEnabled) | ||
| } | ||
| if $data(props("JWTRefreshTokenTimeout"),JWTRefreshTokenTimeout) { | ||
| do $$$AssertStatusOK(1,"JWTRefreshTokenTimeout value is defined") | ||
| do $$$LogMessage(JWTRefreshTokenTimeout) | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or 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,28 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Export generator="Cache" version="25"> | ||
| <Document name="cors-rest-apps.ZPM"> | ||
| <Module> | ||
| <Name>cors-rest-apps</Name> | ||
| <Version>1.0.0</Version> | ||
| <Description>cors enabling testing on webapplication</Description> | ||
| <Keywords>cors</Keywords> | ||
| <Packaging>module</Packaging> | ||
| <Resource Name="CorsTest.PKG"/> | ||
| <WebApplication | ||
| CookiePath="/testcors" | ||
| CorsAllowlist="https://www.example.com,https://pm.intersystems.com" | ||
| CorsCredentialsAllowed="1" | ||
| JWTAccessTokenTimeout="60" | ||
| JWTAuthEnabled="1" | ||
| JWTRefreshTokenTimeout="900" | ||
| CorsHeadersList="Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Headers, Access-Control-Allow-Credentials, Access-Control-Max-Age, Access-Control-Expose-Headers, Access-Control-Request-Method, Access-Control-Request-Headers" | ||
| PasswordAuthEnabled="1" | ||
|
Collaborator
There was a problem hiding this comment. For WebApplication, these properties for auth are all encapsulated as part of AutheEnabled and not separate properties.
Contributor
Author
There was a problem hiding this comment. @isc-kiyer
Collaborator
There was a problem hiding this comment. Presumably this refers to how AutheEnabled is a bit string with these properties, e.g. AutheEnabled=32 means PasswordAuthEnabled=1
Contributor
Author
There was a problem hiding this comment. Hi @isc-kiyer , @isc-dchui
<WebApplication
Url="/testcors"
CookiePath="/testcors"
AutheEnabled="32"
JWTAuthEnabled="1"
JWTAccessTokenTimeout="60"
JWTRefreshTokenTimeout="900"
CorsCredentialsAllowed="1"
CorsAllowlist="https://www.example.com"
CorsHeadersList="Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Headers"
PasswordAuthEnabled="1"
UnauthenticatedEnabled="0"
Recurse="1"
UseCookies="2" />
Could you check and suggest. |
||
| Recurse="1" | ||
| UnauthenticatedEnabled="0" | ||
| Url="/testcors" | ||
| UseCookies="2"/> | ||
| <LifecycleClass>%IPM.Lifecycle.Module</LifecycleClass> | ||
| <SourcesRoot>src</SourcesRoot> | ||
| </Module> | ||
| </Document> | ||
| </Export> | ||
This file contains hidden or 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,17 @@ | ||
| Class CorsTest.Rest.Cors Extends %RegisteredObject | ||
| { | ||
|
|
||
| XData UrlMap [ XMLNamespace = "http://www.intersystems.com/urlmap" ] | ||
| { | ||
| <Routes> | ||
| <Route Url="/" Method="GET" Call="GetInfo" Cors="true"/> | ||
| </Routes> | ||
| } | ||
|
|
||
| ClassMethod GetInfo() As %Status | ||
| { | ||
| write "Hello, World!" | ||
| quit $$$OK | ||
| } | ||
|
|
||
| } |
This file contains hidden or 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,80 @@ | ||
| Class Test.PM.Unit.WebAppCorsTest Extends %UnitTest.TestCase | ||
| { | ||
|
|
||
| Parameter CommonPathPrefix As STRING = "cors-rest-apps"; | ||
|
|
||
| Parameter WebAppName As STRING = "/testcors"; | ||
|
|
||
| /// create web application using <WebApplcation> tag | ||
| Method TestCORSEnabledViaWebAppTag() | ||
| { | ||
| do $$$LogMessage("loading via <WebApplcation> tag") | ||
| set testRoot = ##class(%File).NormalizeDirectory($get(^UnitTestRoot)) | ||
| set moduleDir = ##class(%File).NormalizeDirectory(##class(%File).GetDirectory(testRoot)_"/_data/"_..#CommonPathPrefix_"/webapp/") | ||
| if '##class(%File).DirectoryExists(moduleDir) { | ||
| do ##class(%File).CreateDirectoryChain(moduleDir) | ||
| } | ||
| set moduleFile = ##class(%File).NormalizeFilename("module.xml",moduleDir) | ||
| if ##class(%File).Exists(moduleFile){ | ||
| set status= ##class(%File).Delete(moduleFile) | ||
| do $$$AssertStatusOK(status,"Removed the 'module.xml' file from "_moduleDir) | ||
| } | ||
| do $$$LogMessage("Creating module.xml with <WebApplcation> tag") | ||
| set moduleStream = ##class(%Dictionary.XDataDefinition).%OpenId($classname()_"||ModuleWithWebApTag").Data | ||
| set fileStream = ##class(%Stream.FileBinary).%New() | ||
| set fileStream.Filename=moduleFile | ||
| set status= fileStream.CopyFromAndSave(moduleStream) | ||
| do $$$AssertStatusOK(status,"Created module.xml manually on "_moduleDir_" successfully.") | ||
|
|
||
| set status = ##class(%IPM.Main).Shell("load "_moduleDir) | ||
| do $$$AssertStatusOK(status,"Loaded "_..#CommonPathPrefix_" module successfully. "_moduleDir) | ||
| do ..VerifyCORSSettings() | ||
|
|
||
| set status = ##class(%IPM.Main).Shell("uninstall "_..#CommonPathPrefix) | ||
| do $$$AssertStatusOK(status,"uninstalled "_..#CommonPathPrefix_" module successfully.") | ||
| } | ||
|
|
||
| Method VerifyCORSSettings() | ||
| { | ||
| new $namespace | ||
| set $namespace = "%SYS" | ||
| set status = ##class(Security.Applications).Get(..#WebAppName,.props) | ||
| do $$$AssertStatusOK(status,"Web applciation "_..#WebAppName_" created scuccessfully") | ||
| if $data(props("CorsAllowlist"),corsAllowlist)&&(corsAllowlist'="") { | ||
| do $$$AssertStatusOK(1,"CorsAllowlist values are defined") | ||
| do $$$LogMessage(corsAllowlist) | ||
| } | ||
| if $data(props("CorsCredentialsAllowed"),corsAllow)&&(corsAllow'="") { | ||
| do $$$AssertStatusOK(1,"CorsCredentialsAllowed values are defined") | ||
| do $$$LogMessage(corsAllow) | ||
| } | ||
| if $data(props("CorsHeadersList"),corsHeadersList)&&(corsHeadersList'="") { | ||
| do $$$AssertStatusOK(1,"CorsHeadersList values are defined") | ||
| do $$$LogMessage(corsHeadersList) | ||
| } | ||
| } | ||
|
|
||
| XData ModuleWithWebApTag [ MimeType = application/xml ] | ||
| { | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Export generator="Cache" version="25"> | ||
| <Document name="cors-rest-apps.ZPM"> | ||
| <Module> | ||
| <Name>cors-rest-apps</Name> | ||
| <Version>1.0.0</Version> | ||
| <Description>cors enabling testing on webapplication</Description> | ||
| <Keywords>cors</Keywords> | ||
| <Packaging>module</Packaging> | ||
| <WebApplication Url="/testcors" CookiePath="/testcors" | ||
| CorsAllowlist="https://pm.intersystems.com" | ||
| CorsCredentialsAllowed="1" | ||
| CorsHeadersList="Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Headers, Access-Control-Allow-Credentials, Access-Control-Max-Age, Access-Control-Expose-Headers, Origin, Access-Control-Request-Method, Access-Control-Request-Headers" | ||
| PasswordAuthEnabled="1" Recurse="1" UnauthenticatedEnabled="0" UseCookies="2"/> | ||
|
||
| <LifecycleClass>%IPM.Lifecycle.Module</LifecycleClass> | ||
| <SourcesRoot>src</SourcesRoot> | ||
| </Module> | ||
| </Document> | ||
| </Export> | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: use
ifinstead of#ifUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the code based on the comment