Hands-on Lab
Straight forward Hands-on Lab for StoneAssemblies.MassAuth
Prerequisites
The final source code of this Hands-on Lab is in the StoneAssemblies.MassAuth.QuickStart repository available on GitHub. You can directly clone this repository or just follow the steps outlined below.
Step 1: Setup the workspace
To setup the workspace, open a PowerShell console and run the following commands:
After executing theses commands, a Visual Studio solution file StoneAssemblies.MassAuth.QuickStart.sln is created, which includes the following projects:
Project | Description |
---|---|
StoneAssemblies.MassAuth.QuickStart.Messages | Class library for messages specification. |
StoneAssemblies.MassAuth.QuickStart.Rules | Class library to implement rules for messages. |
StoneAssemblies.MassAuth.QuickStart.Services | Web API to host the services that require to be authorized by rules. |
StoneAssemblies.MassAuth.QuickStart.AuthServer | Authorization server to host the rules for messages. |
The commands also add the required NuGet packages and project references.
The workspace also include two more aditional files. The build.cake
, a cake based build script to ensure the required output and location and the deployment\tye\tye.yaml
that will help us to run and debug the solution.
Step 2: Contract first
Let’s add a bit of complexity to the generated problem, related with weather forecast. For instance, let’s say we will allow to request forecast from a certain date, as some forecasts may not be available due to the complexity of the calculations.
For that purpose, we will add the following class to the Message project, to request the weather forecast with start date as argument.
Step 3: Implementing rules
Now we are ready to implement some rules for the specified message. Continuing with our scenario, let’s say the forecast data is only available from today and up to 10 days. This operation could be more complex through query to an external database, but for simplicity it will be implemented as follows in the Rules project.
Step 4: Implementing services
It’s time to complete the WeatherForecastController implementation in the Services project. It should look like this.
Notice the usage of AuthorizeByRule attribute on the Get method, to indicate that the input message WeatherForecastRequestMessage must be processed and validated by the authorization engine before the method execution.
We also have to update the Startup class implementation.
Basically, the AddMassAuth service collection extension method is called to register the library services and also ensure the communication through the message broker. Remember, StoneAssemblies.MassAuth is built on top of MassTransit. Finally, to read the configuration fro environment variables we must update the Program class to this.
Step 5: Hosting rules
The AuthServer project is responsible for hosting the rules. The rules assemblies are loaded as plugins via StoneAssemblies.Extensibility. Since the extensibility system is NuGet based, rules and messages must be provisioned as NuGet packages.
There is a production ready StoneAssemblies.MassAuth.Server docker image available in DockerHub.
For debugging or even for customization purpose could be useful build your own rule host server project and the Startup class implementation must be updated to initialize the extensibility system and load rules.
Again, to read the configuration from the environment variables the Program file must be updated like this.
Step 6: Build, run and test
In order to build and run the project, open a PowerShell terminal in the working directory and run following commands.
> dotnet cake
> cd deployment/tye
> tye run
Open your browser and navigate to http://localhost:8000 to display the Tye user interface and ensure that everything is working.
Open a new PowerShell terminal and try the following commands:
A) Input: Valid request
Invoke-WebRequest http://localhost:6001/WeatherForecast?StartDate=$([System.DateTime]::Now.AddDays(1).Date)
Output:
StatusCode : 200
StatusDescription : OK
Content : [{"date":"2021-08-24T00:00:00","temperatureC":21,"temperatureF":69,"summary":"Chilly"},{"date":"2021-08-25T00:00:00","temperatureC":4,"tem
peratureF":39,"summary":"Chilly"},{"date":"2021-08-26T00:00:00...
RawContent : HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Date: Sun, 22 Aug 2021 18:38:21 GMT
Server: Kestrel
[{"date":"2021-08-24T00:00:00","temperatureC":21,"te...
Forms : {}
Headers : {[Transfer-Encoding, chunked], [Content-Type, application/json; charset=utf-8], [Date, Sun, 22 Aug 2021 18:38:21 GMT], [Server, Kestrel]}
Images : {}
InputFields : {}
Links : {}
ParsedHtml : mshtml.HTMLDocumentClass
RawContentLength : 435
B) Input: Out of range request
Invoke-WebRequest http://localhost:6001/WeatherForecast?StartDate=$([System.DateTime]::Now.AddDays(11).Date)
Output:
Invoke-WebRequest : The remote server returned an error: (401) Unauthorized.
At line:1 char:1
+ Invoke-WebRequest http://localhost:6001/WeatherForecast?StartDate=$([ ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-WebRequest], WebException
+ FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeWebRequestCommand