ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer 1.0.0.9 

dotnet add package ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer --version 1.0.0.9
                    


                    

                
NuGet\Install-Package ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer -Version 1.0.0.9
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer" Version="1.0.0.9">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer" Version="1.0.0.9" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer --version 1.0.0.9
                    


                    

                
#r "nuget: ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer, 1.0.0.9"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer&version=1.0.0.9
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer&version=1.0.0.9
                    


                            Install as a Cake Tool

Controller Required Auth Analyzer

The purpose of this repo is to create a NuGet package which hosts a C# Roslyn Analyzer to call out ASP.NET Core Controllers/Endpoints which do not specify what AuthN/AuthZ is needed. The purpose is to force each controller to specify an Auth attribute, or to force each endpoint in a controller to specify an Auth attribute. This way you know what level of Auth is required by looking directly at the file you are in without having to remember some combination of Global Auth/Controller Level Auth/Endpoint Level Auth.

Why?

It's for simplicity. Having to keep track of multiple places where auth is defined for an API will eventually lead to a bug where an endpoint doesn't have the correct level of auth. By forcing an Auth attribute in the controller file, we lessen the chance of making that mistake.

And you don't want to make that mistake, because there's enough automated tooling out there (for example: https://github.com/amir-hosseinpour/api-authentication-checker) to test which endpoints don't have authentication required, or just don't require the right amout of authentication.

How to use this?

It's a Roslyn Analyzer, so all you have to do is add the ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer NuGet to your .csproj file.

https://www.nuget.org/packages/ProgrammerAL.Analyzers.ControllerRequiredAuthAnalyzer

What rules does it analyze for?

  • PAL3000
    • No Auth attributes were found in the Controller class. Either add an Auth attribute to the Controller itself, or add an attribute to all endpoints.
  • PAL3001
    • One or more endpoints were found that do have Auth attributes, but one or more were found without it. Add an Auth attribute to the remaining endpoints.
  • PAL3002
    • Both the Controller and one or more endpoints have an auth attribute. Modify the code so the attributes are over the Controller OR the individual endpoints.

Can we be strict?

If you would instead like to force all endpoints to have an Auth attribute and not have any at the controller level, there is another Roslyn Analyzer hosted at: https://github.com/ProgrammerAL/required-auth.analyzer

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0.9 248 6/10/2025
0.1.0-preview.6 240 6/9/2025