class RustAuthTagger

Defined in:

tagger/framework_taggers/rust/rust_auth.cr

Constant Summary

ACTIX_AUTH_PATTERNS = [/HttpAuthentication/, /BearerAuth/, /BasicAuth/, /Identity/]

Actix-Web auth middleware/extractor patterns

AXUM_EXTRACTOR_PATTERNS = [/Extension<.*(?:Auth|Claims|Token|User|Session).*>/, /TypedHeader<.*(?:Authorization|Bearer).*>/]

Axum extractor patterns

GUARD_ATTRIBUTE_PATTERNS = [/#\[guard\s*=\s*"(\w+)"\]/, /#\[.*guard.*\]/i]

Guard/middleware attribute patterns

GUARD_TYPE_PATTERNS = [/\b(?:Auth|Authenticated|AuthGuard|AuthUser|AuthToken)\b/, /\b(?:ApiKey|ApiToken|BearerToken|AccessToken)\b/, /\b(?:Claims|JwtClaims|TokenClaims|JwtToken)\b/, /\b(?:AdminUser|AdminGuard|Admin)\b/, /\b(?:UserGuard|UserToken|CurrentUser|LoggedInUser)\b/, /\b(?:Session|SessionUser|CookieAuth)\b/, /\b(?:RoleGuard|Permission|Authorized)\b/]

Rocket request guard types (in function signatures)

MIDDLEWARE_LAYER_PATTERNS = [/\.wrap\s*\(\s*(\w*[Aa]uth\w*)/, /\.wrap\s*\(\s*HttpAuthentication/, /\.layer\s*\(\s*(\w*[Aa]uth\w*)/, /\.layer\s*\(\s*middleware::from_fn\s*\(\s*(\w*auth\w*)/i]

Middleware layer patterns (in Router/App setup)

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class FrameworkTagger

base_relative_path(path : String) : String base_relative_path, class_level_annotation(path : String, lines : Array(String), annotation_name : String) : String | Nil class_level_annotation, collect_files_by_extension(extension : String) : Array(String) collect_files_by_extension, perform(endpoints : Array(Endpoint)) : Array(Endpoint) perform, read_file(path : String) : String | Nil read_file, read_file_lines(path : String) : Array(String) | Nil read_file_lines, read_source_context(endpoint : Endpoint) : Array(SourceContext) read_source_context, static_asset_route?(url : String) : Bool static_asset_route?

Constructor methods inherited from class FrameworkTagger

new(options : Hash(String, YAML::Any)) new

Class methods inherited from class FrameworkTagger

target_techs : Array(String) target_techs

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Instance methods inherited from class Tagger

name : String name, perform(endpoints : Array(Endpoint)) : Array(Endpoint) perform

Constructor methods inherited from class Tagger

new(options : Hash(String, YAML::Any)) new

Class methods inherited from class Tagger

tagger_key : String tagger_key

Constructor Detail

def self.new(options : Hash(String, YAML::Any)) #

[View source]

Class Method Detail

def self.target_techs : Array(String) #

[View source]

Instance Method Detail

def perform(endpoints : Array(Endpoint)) : Array(Endpoint) #
Description copied from class FrameworkTagger

The per-endpoint shape: look at each endpoint, tag in place, hand the array back. Fifteen framework taggers carried a byte-identical copy of this; they now declare only check_endpoint.

Not every framework tagger fits it — eleven still override #perform because they need a pre-scan over the project (config files, middleware registration) before the per-endpoint pass, or they group endpoints first. Those keep their own.


[View source]