mirror of
				https://github.com/nsnail/Ocelot.git
				synced 2025-11-04 15:30:49 +08:00 
			
		
		
		
	Merging upstream
This commit is contained in:
		@@ -1,3 +1,4 @@
 | 
			
		||||
using System;
 | 
			
		||||
using IdentityServer4.AccessTokenValidation;
 | 
			
		||||
using Microsoft.AspNetCore.Builder;
 | 
			
		||||
using Microsoft.AspNetCore.Http;
 | 
			
		||||
 
 | 
			
		||||
@@ -34,8 +34,6 @@ namespace Ocelot.Authentication.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.TraceMiddlewareEntry();
 | 
			
		||||
 | 
			
		||||
            if (IsAuthenticatedRoute(DownstreamRoute.ReRoute))
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug($"{context.Request.Path} is an authenticated route. {MiddlwareName} checking if client is authenticated");
 | 
			
		||||
@@ -46,7 +44,6 @@ namespace Ocelot.Authentication.Middleware
 | 
			
		||||
                {
 | 
			
		||||
                    _logger.LogError($"Error getting authentication handler for {context.Request.Path}. {authenticationHandler.Errors.ToErrorString()}");
 | 
			
		||||
                    SetPipelineError(authenticationHandler.Errors);
 | 
			
		||||
                    _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
@@ -56,11 +53,7 @@ namespace Ocelot.Authentication.Middleware
 | 
			
		||||
                if (context.User.Identity.IsAuthenticated)
 | 
			
		||||
                {
 | 
			
		||||
                    _logger.LogDebug($"Client has been authenticated for {context.Request.Path}");
 | 
			
		||||
 | 
			
		||||
                    _logger.TraceInvokeNext();
 | 
			
		||||
                        await _next.Invoke(context);
 | 
			
		||||
                    _logger.TraceInvokeNextCompleted();
 | 
			
		||||
                    _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                    await _next.Invoke(context);
 | 
			
		||||
                }
 | 
			
		||||
                else
 | 
			
		||||
                {
 | 
			
		||||
@@ -72,8 +65,6 @@ namespace Ocelot.Authentication.Middleware
 | 
			
		||||
 | 
			
		||||
                    _logger.LogError($"Client has NOT been authenticated for {context.Request.Path} and pipeline error set. {error.ToErrorString()}");
 | 
			
		||||
                    SetPipelineError(error);
 | 
			
		||||
 | 
			
		||||
                    _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
@@ -81,10 +72,7 @@ namespace Ocelot.Authentication.Middleware
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogTrace($"No authentication needed for {context.Request.Path}");
 | 
			
		||||
 | 
			
		||||
                _logger.TraceInvokeNext();
 | 
			
		||||
                    await _next.Invoke(context);
 | 
			
		||||
                _logger.TraceInvokeNextCompleted();
 | 
			
		||||
                _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -33,8 +33,6 @@ namespace Ocelot.Authorisation.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug("started authorisation");
 | 
			
		||||
 | 
			
		||||
            if (IsAuthenticatedRoute(DownstreamRoute.ReRoute))
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("route is authenticated scopes must be checked");
 | 
			
		||||
@@ -73,7 +71,7 @@ namespace Ocelot.Authorisation.Middleware
 | 
			
		||||
 | 
			
		||||
                if (authorised.IsError)
 | 
			
		||||
                {
 | 
			
		||||
                    _logger.LogDebug("error authorising user");
 | 
			
		||||
                    _logger.LogDebug($"Error whilst authorising {context.User.Identity.Name} for {context.User.Identity.Name}. Setting pipeline error");
 | 
			
		||||
 | 
			
		||||
                    SetPipelineError(authorised.Errors);
 | 
			
		||||
                    return;
 | 
			
		||||
@@ -81,30 +79,23 @@ namespace Ocelot.Authorisation.Middleware
 | 
			
		||||
 | 
			
		||||
                if (IsAuthorised(authorised))
 | 
			
		||||
                {
 | 
			
		||||
                    _logger.LogDebug("user is authorised calling next middleware");
 | 
			
		||||
 | 
			
		||||
                    _logger.LogDebug($"{context.User.Identity.Name} has succesfully been authorised for {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}. Calling next middleware");
 | 
			
		||||
                    await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
                    _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
                }
 | 
			
		||||
                else
 | 
			
		||||
                {
 | 
			
		||||
                    _logger.LogDebug("user is not authorised setting pipeline error");
 | 
			
		||||
                    _logger.LogDebug($"{context.User.Identity.Name} is not authorised to access {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}. Setting pipeline error");
 | 
			
		||||
 | 
			
		||||
                    SetPipelineError(new List<Error>
 | 
			
		||||
                    {
 | 
			
		||||
                        new UnauthorisedError(
 | 
			
		||||
                            $"{context.User.Identity.Name} unable to access {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}")
 | 
			
		||||
                        new UnauthorisedError($"{context.User.Identity.Name} is not authorised to access {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}")
 | 
			
		||||
                    });
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
            else
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("AuthorisationMiddleware.Invoke route is not authorised calling next middleware");
 | 
			
		||||
 | 
			
		||||
                _logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate.Value} route does not require user to be authorised");
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
                _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -54,8 +54,6 @@ namespace Ocelot.Cache.Middleware
 | 
			
		||||
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
 | 
			
		||||
            if (PipelineError)
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("there was a pipeline error for {downstreamUrlKey}", downstreamUrlKey);
 | 
			
		||||
 
 | 
			
		||||
@@ -26,8 +26,6 @@ namespace Ocelot.Claims.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug("started claims middleware");
 | 
			
		||||
 | 
			
		||||
            if (DownstreamRoute.ReRoute.ClaimsToClaims.Any())
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("this route has instructions to convert claims to other claims");
 | 
			
		||||
@@ -42,12 +40,7 @@ namespace Ocelot.Claims.Middleware
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("calling next middleware");
 | 
			
		||||
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -13,6 +13,8 @@ namespace Ocelot.Configuration.Creator
 | 
			
		||||
            var username = Environment.GetEnvironmentVariable("OCELOT_USERNAME");
 | 
			
		||||
            var hash = Environment.GetEnvironmentVariable("OCELOT_HASH");
 | 
			
		||||
            var salt = Environment.GetEnvironmentVariable("OCELOT_SALT");
 | 
			
		||||
            var credentialsSigningCertificateLocation = Environment.GetEnvironmentVariable("OCELOT_CERTIFICATE");
 | 
			
		||||
            var credentialsSigningCertificatePassword = Environment.GetEnvironmentVariable("OCELOT_CERTIFICATE_PASSWORD");
 | 
			
		||||
 | 
			
		||||
            return new IdentityServerConfiguration(
 | 
			
		||||
                "admin",
 | 
			
		||||
@@ -28,7 +30,9 @@ namespace Ocelot.Configuration.Creator
 | 
			
		||||
                new List<User>
 | 
			
		||||
                {
 | 
			
		||||
                    new User("admin", username, hash, salt)
 | 
			
		||||
                }
 | 
			
		||||
                },
 | 
			
		||||
                credentialsSigningCertificateLocation,
 | 
			
		||||
                credentialsSigningCertificatePassword
 | 
			
		||||
            );
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
@@ -17,5 +17,7 @@ namespace Ocelot.Configuration.Provider
 | 
			
		||||
        AccessTokenType AccessTokenType {get;}
 | 
			
		||||
        bool RequireClientSecret {get;}
 | 
			
		||||
        List<User> Users {get;}
 | 
			
		||||
        string CredentialsSigningCertificateLocation { get; }
 | 
			
		||||
        string CredentialsSigningCertificatePassword { get; }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -17,7 +17,7 @@ namespace Ocelot.Configuration.Provider
 | 
			
		||||
            IEnumerable<string>  grantType,
 | 
			
		||||
            AccessTokenType accessTokenType,
 | 
			
		||||
            bool requireClientSecret,
 | 
			
		||||
            List<User> users)
 | 
			
		||||
            List<User> users, string credentialsSigningCertificateLocation, string credentialsSigningCertificatePassword)
 | 
			
		||||
        {
 | 
			
		||||
            ApiName = apiName;
 | 
			
		||||
            RequireHttps = requireHttps;
 | 
			
		||||
@@ -30,6 +30,8 @@ namespace Ocelot.Configuration.Provider
 | 
			
		||||
            AccessTokenType = accessTokenType;
 | 
			
		||||
            RequireClientSecret = requireClientSecret;
 | 
			
		||||
            Users = users;
 | 
			
		||||
            CredentialsSigningCertificateLocation = credentialsSigningCertificateLocation;
 | 
			
		||||
            CredentialsSigningCertificatePassword = credentialsSigningCertificatePassword;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public string ApiName { get; private set; }
 | 
			
		||||
@@ -43,5 +45,7 @@ namespace Ocelot.Configuration.Provider
 | 
			
		||||
        public AccessTokenType AccessTokenType {get;private set;}
 | 
			
		||||
        public bool RequireClientSecret {get;private set;}
 | 
			
		||||
        public List<User> Users {get;private set;}
 | 
			
		||||
        public string CredentialsSigningCertificateLocation { get; private set; }
 | 
			
		||||
        public string CredentialsSigningCertificatePassword { get; private set; }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -41,6 +41,8 @@ using System.Collections.Generic;
 | 
			
		||||
using System.Linq;
 | 
			
		||||
using System.Net.Http;
 | 
			
		||||
using System.Reflection;
 | 
			
		||||
using System.Security.Cryptography.X509Certificates;
 | 
			
		||||
using Microsoft.IdentityModel.Tokens;
 | 
			
		||||
using Ocelot.Configuration;
 | 
			
		||||
using FileConfigurationProvider = Ocelot.Configuration.Provider.FileConfigurationProvider;
 | 
			
		||||
 | 
			
		||||
@@ -87,8 +89,10 @@ namespace Ocelot.DependencyInjection
 | 
			
		||||
            {
 | 
			
		||||
                services.TryAddSingleton<IIdentityServerConfiguration>(identityServerConfiguration);
 | 
			
		||||
                services.TryAddSingleton<IHashMatcher, HashMatcher>();
 | 
			
		||||
                services.AddIdentityServer()
 | 
			
		||||
                    .AddTemporarySigningCredential()
 | 
			
		||||
                var identityServerBuilder = services
 | 
			
		||||
                    .AddIdentityServer(options => {
 | 
			
		||||
                        options.IssuerUri = "Ocelot";
 | 
			
		||||
                    })
 | 
			
		||||
                    .AddInMemoryApiResources(new List<ApiResource>
 | 
			
		||||
                    {
 | 
			
		||||
                        new ApiResource
 | 
			
		||||
@@ -120,6 +124,16 @@ namespace Ocelot.DependencyInjection
 | 
			
		||||
                            RequireClientSecret = identityServerConfiguration.RequireClientSecret
 | 
			
		||||
                        }
 | 
			
		||||
                    }).AddResourceOwnerValidator<OcelotResourceOwnerPasswordValidator>();
 | 
			
		||||
 | 
			
		||||
                if (string.IsNullOrEmpty(identityServerConfiguration.CredentialsSigningCertificateLocation) || string.IsNullOrEmpty(identityServerConfiguration.CredentialsSigningCertificatePassword))
 | 
			
		||||
                {
 | 
			
		||||
                    identityServerBuilder.AddTemporarySigningCredential();
 | 
			
		||||
                }
 | 
			
		||||
                else
 | 
			
		||||
                {
 | 
			
		||||
                    var cert = new X509Certificate2(identityServerConfiguration.CredentialsSigningCertificateLocation, identityServerConfiguration.CredentialsSigningCertificatePassword);
 | 
			
		||||
                    identityServerBuilder.AddSigningCredential(cert);
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            var assembly = typeof(FileConfigurationController).GetTypeInfo().Assembly;
 | 
			
		||||
@@ -169,6 +183,11 @@ namespace Ocelot.DependencyInjection
 | 
			
		||||
            services.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>();
 | 
			
		||||
            services.TryAddScoped<IRequestScopedDataRepository, HttpDataRepository>();
 | 
			
		||||
            services.AddMemoryCache();
 | 
			
		||||
 | 
			
		||||
            //Used to log the the start and ending of middleware
 | 
			
		||||
            services.TryAddSingleton<OcelotDiagnosticListener>();
 | 
			
		||||
            services.AddMiddlewareAnalysis();
 | 
			
		||||
 | 
			
		||||
            return services;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
@@ -30,8 +30,6 @@ namespace Ocelot.DownstreamRouteFinder.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.TraceMiddlewareEntry();
 | 
			
		||||
 | 
			
		||||
            var upstreamUrlPath = context.Request.Path.ToString().SetLastCharacterAs('/');
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("upstream url path is {upstreamUrlPath}", upstreamUrlPath);
 | 
			
		||||
@@ -43,8 +41,6 @@ namespace Ocelot.DownstreamRouteFinder.Middleware
 | 
			
		||||
                _logger.LogError($"{MiddlwareName} setting pipeline errors. IDownstreamRouteFinder returned {downstreamRoute.Errors.ToErrorString()}");
 | 
			
		||||
 | 
			
		||||
                SetPipelineError(downstreamRoute.Errors);
 | 
			
		||||
 | 
			
		||||
                _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
@@ -52,12 +48,7 @@ namespace Ocelot.DownstreamRouteFinder.Middleware
 | 
			
		||||
 | 
			
		||||
            SetDownstreamRouteForThisRequest(downstreamRoute.Data);
 | 
			
		||||
 | 
			
		||||
            _logger.TraceInvokeNext();
 | 
			
		||||
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            _logger.TraceInvokeNextCompleted();
 | 
			
		||||
            _logger.TraceMiddlewareCompleted();
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -30,8 +30,6 @@ namespace Ocelot.DownstreamUrlCreator.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug("started calling downstream url creator middleware");
 | 
			
		||||
 | 
			
		||||
            var dsPath = _replacer
 | 
			
		||||
                .Replace(DownstreamRoute.ReRoute.DownstreamPathTemplate, DownstreamRoute.TemplatePlaceholderNameAndValues);
 | 
			
		||||
 | 
			
		||||
@@ -53,11 +51,7 @@ namespace Ocelot.DownstreamUrlCreator.Middleware
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("downstream url is {downstreamUrl.Data.Value}", DownstreamRequest.RequestUri);
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("calling next middleware");
 | 
			
		||||
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -26,17 +26,15 @@ namespace Ocelot.Headers.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug("started calling headers builder middleware");
 | 
			
		||||
 | 
			
		||||
            if (DownstreamRoute.ReRoute.ClaimsToHeaders.Any())
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("this route has instructions to convert claims to headers");
 | 
			
		||||
                _logger.LogDebug($"{ DownstreamRoute.ReRoute.DownstreamPathTemplate.Value} has instructions to convert claims to headers");
 | 
			
		||||
 | 
			
		||||
                var response = _addHeadersToRequest.SetHeadersOnDownstreamRequest(DownstreamRoute.ReRoute.ClaimsToHeaders, context.User.Claims, DownstreamRequest);
 | 
			
		||||
 | 
			
		||||
                if (response.IsError)
 | 
			
		||||
                {
 | 
			
		||||
                    _logger.LogDebug("there was an error setting headers on context, setting pipeline error");
 | 
			
		||||
                    _logger.LogDebug("Error setting headers on context, setting pipeline error");
 | 
			
		||||
 | 
			
		||||
                    SetPipelineError(response.Errors);
 | 
			
		||||
                    return;
 | 
			
		||||
@@ -45,11 +43,7 @@ namespace Ocelot.Headers.Middleware
 | 
			
		||||
                _logger.LogDebug("headers have been set on context");
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("calling next middleware");
 | 
			
		||||
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -28,18 +28,18 @@ namespace Ocelot.LoadBalancer.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug("started calling load balancing middleware");
 | 
			
		||||
 | 
			
		||||
            var loadBalancer = _loadBalancerHouse.Get(DownstreamRoute.ReRoute.ReRouteKey);
 | 
			
		||||
            if(loadBalancer.IsError)
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("there was an error retriving the loadbalancer, setting pipeline error");
 | 
			
		||||
                SetPipelineError(loadBalancer.Errors);
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            var hostAndPort = await loadBalancer.Data.Lease();
 | 
			
		||||
            if(hostAndPort.IsError)
 | 
			
		||||
            { 
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("there was an error leasing the loadbalancer, setting pipeline error");
 | 
			
		||||
                SetPipelineError(hostAndPort.Errors);
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
@@ -52,23 +52,19 @@ namespace Ocelot.LoadBalancer.Middleware
 | 
			
		||||
            }
 | 
			
		||||
            DownstreamRequest.RequestUri = uriBuilder.Uri;
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("calling next middleware");
 | 
			
		||||
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
                loadBalancer.Data.Release(hostAndPort.Data);
 | 
			
		||||
            }
 | 
			
		||||
            catch (Exception)
 | 
			
		||||
            {
 | 
			
		||||
                loadBalancer.Data.Release(hostAndPort.Data);
 | 
			
		||||
                 
 | 
			
		||||
                 _logger.LogDebug("error calling next middleware, exception will be thrown to global handler");
 | 
			
		||||
                _logger.LogDebug("Exception calling next middleware, exception will be thrown to global handler");
 | 
			
		||||
                throw;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
            finally
 | 
			
		||||
            {
 | 
			
		||||
                loadBalancer.Data.Release(hostAndPort.Data);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -4,39 +4,39 @@ using Ocelot.Infrastructure.RequestData;
 | 
			
		||||
 | 
			
		||||
namespace Ocelot.Logging
 | 
			
		||||
{
 | 
			
		||||
    public class AspDotNetLogger : IOcelotLogger
 | 
			
		||||
    {
 | 
			
		||||
        private readonly ILogger _logger;
 | 
			
		||||
        private readonly IRequestScopedDataRepository _scopedDataRepository;
 | 
			
		||||
 | 
			
		||||
        public string Name { get; }
 | 
			
		||||
 | 
			
		||||
    public class AspDotNetLogger : IOcelotLogger
 | 
			
		||||
    {
 | 
			
		||||
        private readonly ILogger _logger;
 | 
			
		||||
        private readonly IRequestScopedDataRepository _scopedDataRepository;
 | 
			
		||||
 | 
			
		||||
        public string Name { get; }
 | 
			
		||||
 | 
			
		||||
        public AspDotNetLogger(ILogger logger, IRequestScopedDataRepository scopedDataRepository, string typeName)
 | 
			
		||||
        {
 | 
			
		||||
            Name = typeName;
 | 
			
		||||
            _logger = logger;
 | 
			
		||||
            _scopedDataRepository = scopedDataRepository;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public void LogTrace(string message, params object[] args)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogTrace(GetMessageWithOcelotRequestId(message), args);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public void LogDebug(string message, params object[] args)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug(GetMessageWithOcelotRequestId(message), args);
 | 
			
		||||
        }
 | 
			
		||||
        public void LogError(string message, Exception exception)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogError(GetMessageWithOcelotRequestId(message), exception);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public void LogError(string message, params object[] args)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogError(GetMessageWithOcelotRequestId(message), args);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
            Name = typeName;
 | 
			
		||||
            _logger = logger;
 | 
			
		||||
            _scopedDataRepository = scopedDataRepository;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public void LogTrace(string message, params object[] args)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogTrace(GetMessageWithOcelotRequestId(message), args);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public void LogDebug(string message, params object[] args)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug(GetMessageWithOcelotRequestId(message), args);
 | 
			
		||||
        }
 | 
			
		||||
        public void LogError(string message, Exception exception)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogError(GetMessageWithOcelotRequestId(message), exception);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public void LogError(string message, params object[] args)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogError(GetMessageWithOcelotRequestId(message), args);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        private string GetMessageWithOcelotRequestId(string message)
 | 
			
		||||
        {
 | 
			
		||||
            var requestId = _scopedDataRepository.Get<string>("RequestId");
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										34
									
								
								src/Ocelot/Logging/OcelotDiagnosticListener.cs
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								src/Ocelot/Logging/OcelotDiagnosticListener.cs
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,34 @@
 | 
			
		||||
using System;
 | 
			
		||||
using Microsoft.AspNetCore.Http;
 | 
			
		||||
using Microsoft.Extensions.DiagnosticAdapter;
 | 
			
		||||
 | 
			
		||||
namespace Ocelot.Logging
 | 
			
		||||
{
 | 
			
		||||
    public class OcelotDiagnosticListener
 | 
			
		||||
    {
 | 
			
		||||
        private IOcelotLogger _logger;
 | 
			
		||||
 | 
			
		||||
        public OcelotDiagnosticListener(IOcelotLoggerFactory factory)
 | 
			
		||||
        {
 | 
			
		||||
            _logger = factory.CreateLogger<OcelotDiagnosticListener>();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        [DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareStarting")]
 | 
			
		||||
        public virtual void OnMiddlewareStarting(HttpContext httpContext, string name)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogTrace($"MiddlewareStarting: {name}; {httpContext.Request.Path}");
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        [DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareException")]
 | 
			
		||||
        public virtual void OnMiddlewareException(Exception exception, string name)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogTrace($"MiddlewareException: {name}; {exception.Message}");
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        [DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareFinished")]
 | 
			
		||||
        public virtual void OnMiddlewareFinished(HttpContext httpContext, string name)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogTrace($"MiddlewareFinished: {name}; {httpContext.Response.StatusCode}");
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -1,29 +0,0 @@
 | 
			
		||||
using System;
 | 
			
		||||
using System.Collections.Generic;
 | 
			
		||||
using System.Text;
 | 
			
		||||
 | 
			
		||||
namespace Ocelot.Logging
 | 
			
		||||
{
 | 
			
		||||
    public static class OcelotLoggerExtensions
 | 
			
		||||
    {
 | 
			
		||||
        public static void TraceMiddlewareEntry(this IOcelotLogger logger)
 | 
			
		||||
        {
 | 
			
		||||
            logger.LogTrace($"entered {logger.Name}");
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public static void TraceInvokeNext(this IOcelotLogger logger)
 | 
			
		||||
        {
 | 
			
		||||
            logger.LogTrace($"invoking next middleware from {logger.Name}");
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public static void TraceInvokeNextCompleted(this IOcelotLogger logger)
 | 
			
		||||
        {
 | 
			
		||||
            logger.LogTrace($"returned to {logger.Name} after next middleware completed");
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public static void TraceMiddlewareCompleted(this IOcelotLogger logger)
 | 
			
		||||
        {
 | 
			
		||||
            logger.LogTrace($"completed {logger.Name}");
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -1,4 +1,5 @@
 | 
			
		||||
using System.Collections.Generic;
 | 
			
		||||
using System.Diagnostics;
 | 
			
		||||
using IdentityServer4.AccessTokenValidation;
 | 
			
		||||
using Microsoft.AspNetCore.Builder;
 | 
			
		||||
using Ocelot.Authentication.Middleware;
 | 
			
		||||
@@ -8,6 +9,7 @@ using Ocelot.DownstreamRouteFinder.Middleware;
 | 
			
		||||
using Ocelot.DownstreamUrlCreator.Middleware;
 | 
			
		||||
using Ocelot.Errors.Middleware;
 | 
			
		||||
using Ocelot.Headers.Middleware;
 | 
			
		||||
using Ocelot.Logging;
 | 
			
		||||
using Ocelot.QueryStrings.Middleware;
 | 
			
		||||
using Ocelot.Request.Middleware;
 | 
			
		||||
using Ocelot.Requester.Middleware;
 | 
			
		||||
@@ -53,6 +55,8 @@ namespace Ocelot.Middleware
 | 
			
		||||
        {
 | 
			
		||||
            await CreateAdministrationArea(builder);
 | 
			
		||||
 | 
			
		||||
            ConfigureDiagnosticListener(builder);
 | 
			
		||||
 | 
			
		||||
            // This is registered to catch any global exceptions that are not handled
 | 
			
		||||
            builder.UseExceptionHandlerMiddleware();
 | 
			
		||||
 | 
			
		||||
@@ -181,7 +185,6 @@ namespace Ocelot.Middleware
 | 
			
		||||
                builder.Map(configuration.AdministrationPath, app =>
 | 
			
		||||
                {
 | 
			
		||||
                    var identityServerUrl = $"{baseSchemeUrlAndPort}/{configuration.AdministrationPath.Remove(0,1)}";
 | 
			
		||||
 | 
			
		||||
                    app.UseIdentityServerAuthentication(new IdentityServerAuthenticationOptions
 | 
			
		||||
                    {
 | 
			
		||||
                        Authority = identityServerUrl,
 | 
			
		||||
@@ -206,5 +209,22 @@ namespace Ocelot.Middleware
 | 
			
		||||
                builder.Use(middleware);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        /// <summary>
 | 
			
		||||
         /// Configure a DiagnosticListener to listen for diagnostic events when the middleware starts and ends
 | 
			
		||||
         /// </summary>
 | 
			
		||||
         /// <param name="builder"></param>
 | 
			
		||||
         private static void ConfigureDiagnosticListener(IApplicationBuilder builder)
 | 
			
		||||
         {
 | 
			
		||||
             var env = (IHostingEnvironment)builder.ApplicationServices.GetService(typeof(IHostingEnvironment));
 | 
			
		||||
 | 
			
		||||
            //https://github.com/TomPallister/Ocelot/pull/87 not sure why only for dev envs and marc disapeered so just merging and maybe change one day?
 | 
			
		||||
            if (!env.IsProduction())
 | 
			
		||||
             {
 | 
			
		||||
                 var listener = (OcelotDiagnosticListener)builder.ApplicationServices.GetService(typeof(OcelotDiagnosticListener));
 | 
			
		||||
                 var diagnosticListener = (DiagnosticListener)builder.ApplicationServices.GetService(typeof(DiagnosticListener));
 | 
			
		||||
                 diagnosticListener.SubscribeWithAdapter(listener);
 | 
			
		||||
             }
 | 
			
		||||
         }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -26,10 +26,12 @@
 | 
			
		||||
  </PropertyGroup>
 | 
			
		||||
 | 
			
		||||
  <ItemGroup>
 | 
			
		||||
    <PackageReference Include="Microsoft.AspNetCore.MiddlewareAnalysis" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.AspNetCore.Server.IISIntegration" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.DiagnosticAdapter" Version="1.1.0" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="1.1.1" />
 | 
			
		||||
    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.1.1" />
 | 
			
		||||
 
 | 
			
		||||
@@ -26,11 +26,9 @@ namespace Ocelot.QueryStrings.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.LogDebug("started calling query string builder middleware");
 | 
			
		||||
 | 
			
		||||
            if (DownstreamRoute.ReRoute.ClaimsToQueries.Any())
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug("this route has instructions to convert claims to queries");
 | 
			
		||||
                _logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate.Value} has instructions to convert claims to queries");
 | 
			
		||||
 | 
			
		||||
                var response = _addQueriesToRequest.SetQueriesOnDownstreamRequest(DownstreamRoute.ReRoute.ClaimsToQueries, context.User.Claims, DownstreamRequest);
 | 
			
		||||
 | 
			
		||||
@@ -43,11 +41,7 @@ namespace Ocelot.QueryStrings.Middleware
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("calling next middleware");
 | 
			
		||||
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            _logger.LogDebug("succesfully called next middleware");
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -31,18 +31,12 @@ namespace Ocelot.RateLimit.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.TraceMiddlewareEntry();
 | 
			
		||||
 | 
			
		||||
            var options = DownstreamRoute.ReRoute.RateLimitOptions;
 | 
			
		||||
            // check if rate limiting is enabled
 | 
			
		||||
            if (!DownstreamRoute.ReRoute.EnableEndpointEndpointRateLimiting)
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug($"EndpointRateLimiting is not enabled for {DownstreamRoute.ReRoute.DownstreamPathTemplate}");
 | 
			
		||||
 | 
			
		||||
                _logger.TraceInvokeNext();
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
                _logger.TraceInvokeNextCompleted();
 | 
			
		||||
                _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
            // compute identity from request
 | 
			
		||||
@@ -52,11 +46,7 @@ namespace Ocelot.RateLimit.Middleware
 | 
			
		||||
            if (IsWhitelisted(identity, options))
 | 
			
		||||
            {
 | 
			
		||||
                _logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate} is white listed from rate limiting");
 | 
			
		||||
 | 
			
		||||
                _logger.TraceInvokeNext();
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
                _logger.TraceInvokeNextCompleted();
 | 
			
		||||
                _logger.TraceMiddlewareCompleted();
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
@@ -78,7 +68,6 @@ namespace Ocelot.RateLimit.Middleware
 | 
			
		||||
                    var retrystring = retryAfter.ToString(System.Globalization.CultureInfo.InvariantCulture);
 | 
			
		||||
                    // break execution
 | 
			
		||||
                    await ReturnQuotaExceededResponse(context, options, retrystring);
 | 
			
		||||
                    _logger.TraceMiddlewareCompleted();
 | 
			
		||||
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
@@ -91,10 +80,7 @@ namespace Ocelot.RateLimit.Middleware
 | 
			
		||||
                context.Response.OnStarting(SetRateLimitHeaders, state: headers);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            _logger.TraceInvokeNext();
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
            _logger.TraceInvokeNextCompleted();
 | 
			
		||||
            _logger.TraceMiddlewareCompleted();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public virtual ClientRequestIdentity SetIdentity(HttpContext httpContext, RateLimitOptions option)
 | 
			
		||||
 
 | 
			
		||||
@@ -20,7 +20,7 @@ namespace Ocelot.RequestId.Middleware
 | 
			
		||||
        public RequestIdMiddleware(RequestDelegate next,
 | 
			
		||||
            IOcelotLoggerFactory loggerFactory,
 | 
			
		||||
            IRequestScopedDataRepository requestScopedDataRepository)
 | 
			
		||||
            :base(requestScopedDataRepository)
 | 
			
		||||
            : base(requestScopedDataRepository)
 | 
			
		||||
        {
 | 
			
		||||
            _next = next;
 | 
			
		||||
            _logger = loggerFactory.CreateLogger<RequestIdMiddleware>();
 | 
			
		||||
@@ -28,15 +28,9 @@ namespace Ocelot.RequestId.Middleware
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {         
 | 
			
		||||
            _logger.TraceMiddlewareEntry();
 | 
			
		||||
 | 
			
		||||
        {
 | 
			
		||||
            SetOcelotRequestId(context);
 | 
			
		||||
 | 
			
		||||
            _logger.TraceInvokeNext();
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
            _logger.TraceInvokeNextCompleted();
 | 
			
		||||
            _logger.TraceMiddlewareCompleted();
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        private void SetOcelotRequestId(HttpContext context)
 | 
			
		||||
 
 | 
			
		||||
@@ -34,10 +34,7 @@ namespace Ocelot.Responder.Middleware
 | 
			
		||||
 | 
			
		||||
        public async Task Invoke(HttpContext context)
 | 
			
		||||
        {
 | 
			
		||||
            _logger.TraceMiddlewareEntry();
 | 
			
		||||
            _logger.TraceInvokeNext();
 | 
			
		||||
                await _next.Invoke(context);
 | 
			
		||||
            _logger.TraceInvokeNextCompleted();
 | 
			
		||||
            await _next.Invoke(context);
 | 
			
		||||
 | 
			
		||||
            if (PipelineError)
 | 
			
		||||
            {
 | 
			
		||||
@@ -51,7 +48,6 @@ namespace Ocelot.Responder.Middleware
 | 
			
		||||
                _logger.LogDebug("no pipeline errors, setting and returning completed response");
 | 
			
		||||
                await _responder.SetResponseOnHttpContext(context, HttpResponseMessage);
 | 
			
		||||
            }
 | 
			
		||||
            _logger.TraceMiddlewareCompleted();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        private void SetErrorResponse(HttpContext context, List<Error> errors)
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user