CorsMiddleware::getAllowedPatterns() - Code Metrics - Inspection of "feat: enhance CORS middleware and update domain se..." - cslant/blog-api-package - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 6a18bd...fd1e99 )

by Tan

created 2025-06-08 06:21 UTC

CorsMiddleware::getAllowedPatterns() A

↳ Parent: CorsMiddleware

Complexity

Conditions	1
Paths	1

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	13
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	24
rs	9.8333

<?php

namespace CSlant\Blog\Api\Http\Middlewares;

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

class CorsMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        // Handle preflight OPTIONS request
        if ($request->getMethod() === 'OPTIONS') {
            return response('', 200)
                ->header('Access-Control-Allow-Origin', $this->getAllowedOrigin($request))
                ->header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS, PATCH')
                ->header('Access-Control-Allow-Headers', 'Accept, Authorization, Content-Type, X-Requested-With, X-CSRF-TOKEN, X-XSRF-TOKEN, Origin, Cache-Control, Pragma')
                ->header('Access-Control-Allow-Credentials', 'true')
                ->header('Access-Control-Max-Age', '86400');
        }

        $response = $next($request);

        // Add CORS headers to response
        $response->headers->set('Access-Control-Allow-Origin', $this->getAllowedOrigin($request));
        $response->headers->set('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS, PATCH');
        $response->headers->set('Access-Control-Allow-Headers', 'Accept, Authorization, Content-Type, X-Requested-With, X-CSRF-TOKEN, X-XSRF-TOKEN, Origin, Cache-Control, Pragma');
        $response->headers->set('Access-Control-Allow-Credentials', 'true');
        $response->headers->set('Access-Control-Expose-Headers', 'Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, Pragma');

        return $response;
    }

    /**
     * Get allowed origin for the request.
     */
    private function getAllowedOrigin(Request $request): string
    {
        $origin = $request->headers->get('Origin');

        // Get environment-specific configurations
        $allowedOrigins = $this->getAllowedOrigins();

        // Check if origin is in allowed list
        if (in_array($origin, $allowedOrigins)) {
            return $origin;
        }

        // Check against patterns
        $allowedPatterns = $this->getAllowedPatterns();

        foreach ($allowedPatterns as $pattern) {
            if (preg_match($pattern, $origin)) {
                return $origin;
            }
        }

        // Default to first allowed origin or the origin itself if it matches basic security rules
        if ($this->isSecureOrigin($origin)) {
            return $origin;
        }

        return $allowedOrigins[0] ?? '*';
    }

    /**
     * Get all allowed origins based on environment.
     */
    private function getAllowedOrigins(): array
    {
        $baseOrigins = [
            // Environment-specific URLs from .env
            env('BLOG_FE_URL'),
            env('BLOG_ADMIN_URL'),
            env('BLOG_API_URL'),
            env('APP_URL'),

            // Development origins
            'http://localhost',
            'http://localhost:3000',
            'http://localhost:5173', // Vite default
            'http://127.0.0.1',
            'http://127.0.0.1:3000',

            // Development with .local domains
            'http://cslant.com.local',
            'http://cslant.com.local:81',

            // Production domains (without .local)
            'https://cslant.com',
            'https://api-docs.cslant.com',

            // Staging domains
            'https://staging.cslant.com',
        ];

        // Filter out null values and return unique origins
        return array_unique(array_filter($baseOrigins));
    }

    /**
     * Get allowed patterns for dynamic origin matching.
     */
    private function getAllowedPatterns(): array
    {
        return [
            // Development patterns (.local domains)
            '/^https?:\/\/[a-zA-Z0-9\-]+\.cslant\.com\.local(:\d+)?$/',
            '/^https?:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.cslant\.com\.local(:\d+)?$/',

            // Production patterns (without .local)
            '/^https:\/\/[a-zA-Z0-9\-]+\.cslant\.com$/',
            '/^https:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.cslant\.com$/',
            '/^http:\/\/[a-zA-Z0-9\-]+\.cslant\.com$/',
            '/^http:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.cslant\.com$/',

            // Staging patterns
            '/^https?:\/\/[a-zA-Z0-9\-]+\.staging\.cslant\.com$/',
            '/^https?:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.staging\.cslant\.com$/',

            // Localhost patterns with any port
            '/^https?:\/\/localhost(:\d+)?$/',
            '/^https?:\/\/127\.0\.0\.1(:\d+)?$/',
            '/^https?:\/\/0\.0\.0\.0(:\d+)?$/',

            // Custom domain patterns from environment
            $this->getCustomDomainPattern(),
        ];
    }

    /**
     * Get custom domain pattern from environment.
     */
    private function getCustomDomainPattern(): string
    {
        $customDomain = env('CORS_CUSTOM_DOMAIN_PATTERN');
        return $customDomain ?: '/^$/'; // Empty pattern if not set

    }

    /**
     * Check if origin is secure (basic security validation).
     */
    private function isSecureOrigin(?string $origin): bool
    {
        // Allow null origin (for mobile apps, Postman, etc.)
        if (empty($origin)) {
            return true;
        }

        // Must be a valid URL
        if (!filter_var($origin, FILTER_VALIDATE_URL)) {
            return false;
        }

        $parsed = parse_url($origin);

        // Must have valid scheme
        if (!in_array($parsed['scheme'] ?? '', ['http', 'https'])) {
            return false;
        }

        // Block dangerous hosts
        $dangerousHosts = ['0.0.0.0', '255.255.255.255'];
        if (in_array($parsed['host'] ?? '', $dangerousHosts)) {
            return false;
        }

        return true;
    }
}


1			<?php
2
3			namespace CSlant\Blog\Api\Http\Middlewares;
4
5			use Closure;
6			use Illuminate\Http\Request;
7			use Symfony\Component\HttpFoundation\Response;
8
9			class CorsMiddleware
10			{
11			/**
12			* Handle an incoming request.
13			*
14			* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
15			*/
16			public function handle(Request $request, Closure $next): Response
17			{
18			// Handle preflight OPTIONS request
19			if ($request->getMethod() === 'OPTIONS') {
20			return response('', 200)
21			->header('Access-Control-Allow-Origin', $this->getAllowedOrigin($request))
22			->header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS, PATCH')
23			->header('Access-Control-Allow-Headers', 'Accept, Authorization, Content-Type, X-Requested-With, X-CSRF-TOKEN, X-XSRF-TOKEN, Origin, Cache-Control, Pragma')
24			->header('Access-Control-Allow-Credentials', 'true')
25			->header('Access-Control-Max-Age', '86400');
26			}
27
28			$response = $next($request);
29
30			// Add CORS headers to response
31			$response->headers->set('Access-Control-Allow-Origin', $this->getAllowedOrigin($request));
32			$response->headers->set('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS, PATCH');
33			$response->headers->set('Access-Control-Allow-Headers', 'Accept, Authorization, Content-Type, X-Requested-With, X-CSRF-TOKEN, X-XSRF-TOKEN, Origin, Cache-Control, Pragma');
34			$response->headers->set('Access-Control-Allow-Credentials', 'true');
35			$response->headers->set('Access-Control-Expose-Headers', 'Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, Pragma');
36
37			return $response;
38			}
39
40			/**
41			* Get allowed origin for the request.
42			*/
43			private function getAllowedOrigin(Request $request): string
44			{
45			$origin = $request->headers->get('Origin');
46
47			// Get environment-specific configurations
48			$allowedOrigins = $this->getAllowedOrigins();
49
50			// Check if origin is in allowed list
51			if (in_array($origin, $allowedOrigins)) {
52			return $origin;
53			}
54
55			// Check against patterns
56			$allowedPatterns = $this->getAllowedPatterns();
57
58			foreach ($allowedPatterns as $pattern) {
59			if (preg_match($pattern, $origin)) {
60			return $origin;
61			}
62			}
63
64			// Default to first allowed origin or the origin itself if it matches basic security rules
65			if ($this->isSecureOrigin($origin)) {
66			return $origin;
67			}
68
69			return $allowedOrigins[0] ?? '*';
70			}
71
72			/**
73			* Get all allowed origins based on environment.
74			*/
75			private function getAllowedOrigins(): array
76			{
77			$baseOrigins = [
78			// Environment-specific URLs from .env
79			env('BLOG_FE_URL'),
80			env('BLOG_ADMIN_URL'),
81			env('BLOG_API_URL'),
82			env('APP_URL'),
83
84			// Development origins
85			'http://localhost',
86			'http://localhost:3000',
87			'http://localhost:5173', // Vite default
88			'http://127.0.0.1',
89			'http://127.0.0.1:3000',
90
91			// Development with .local domains
92			'http://cslant.com.local',
93			'http://cslant.com.local:81',
94
95			// Production domains (without .local)
96			'https://cslant.com',
97			'https://api-docs.cslant.com',
98
99			// Staging domains
100			'https://staging.cslant.com',
101			];
102
103			// Filter out null values and return unique origins
104			return array_unique(array_filter($baseOrigins));
105			}
106
107			/**
108			* Get allowed patterns for dynamic origin matching.
109			*/
110			private function getAllowedPatterns(): array
111			{
112			return [
113			// Development patterns (.local domains)
114			'/^https?:\/\/[a-zA-Z0-9\-]+\.cslant\.com\.local(:\d+)?$/',
115			'/^https?:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.cslant\.com\.local(:\d+)?$/',
116
117			// Production patterns (without .local)
118			'/^https:\/\/[a-zA-Z0-9\-]+\.cslant\.com$/',
119			'/^https:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.cslant\.com$/',
120			'/^http:\/\/[a-zA-Z0-9\-]+\.cslant\.com$/',
121			'/^http:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.cslant\.com$/',
122
123			// Staging patterns
124			'/^https?:\/\/[a-zA-Z0-9\-]+\.staging\.cslant\.com$/',
125			'/^https?:\/\/[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-]+\.staging\.cslant\.com$/',
126
127			// Localhost patterns with any port
128			'/^https?:\/\/localhost(:\d+)?$/',
129			'/^https?:\/\/127\.0\.0\.1(:\d+)?$/',
130			'/^https?:\/\/0\.0\.0\.0(:\d+)?$/',
131
132			// Custom domain patterns from environment
133			$this->getCustomDomainPattern(),
134			];
135			}
136
137			/**
138			* Get custom domain pattern from environment.
139			*/
140			private function getCustomDomainPattern(): string
141			{
142			$customDomain = env('CORS_CUSTOM_DOMAIN_PATTERN');
143			return $customDomain ?: '/^$/'; // Empty pattern if not set
			0 ignored issues – show introduced 2025-06-08 06:24 UTC by Report Bug Copy Issue Report `$customDomain` is of type `PhpOption\T`, thus it always evaluated to `true`. Loading history...
144			}
145
146			/**
147			* Check if origin is secure (basic security validation).
148			*/
149			private function isSecureOrigin(?string $origin): bool
150			{
151			// Allow null origin (for mobile apps, Postman, etc.)
152			if (empty($origin)) {
153			return true;
154			}
155
156			// Must be a valid URL
157			if (!filter_var($origin, FILTER_VALIDATE_URL)) {
158			return false;
159			}
160
161			$parsed = parse_url($origin);
162
163			// Must have valid scheme
164			if (!in_array($parsed['scheme'] ?? '', ['http', 'https'])) {
165			return false;
166			}
167
168			// Block dangerous hosts
169			$dangerousHosts = ['0.0.0.0', '255.255.255.255'];
170			if (in_array($parsed['host'] ?? '', $dangerousHosts)) {
171			return false;
172			}
173
174			return true;
175			}
176			}
177

cslant / blog-api-package

Push — main ( 6a18bd...fd1e99 )

CorsMiddleware::getAllowedPatterns() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like