ForwardedTransformExtensions Methods

WithTransformClientCertHeader(YarpRoute, string)extensionYarpRoute

Adds the transform which will set the given header with the Base64 encoded client certificate.

public static class ForwardedTransformExtensions
{
    public static YarpRoute WithTransformClientCertHeader(
        this YarpRoute route,
        string headerName)
    {
        // ...
    }
}

ForwardedTransformExtensions.cs#L48-L49

Parameters

routeYarpRoute

headerNamestring

WithTransformForwarded(YarpRoute, bool, bool, NodeFormat, NodeFormat, ForwardedTransformActions)extensionYarpRoute

Adds the transform which will add the Forwarded header as defined by [RFC 7239](https://tools.ietf.org/html/rfc7239).

public static class ForwardedTransformExtensions
{
    public static YarpRoute WithTransformForwarded(
        this YarpRoute route,
        bool useHost = true,
        bool useProto = true,
        NodeFormat forFormat = NodeFormat.Random,
        NodeFormat byFormat = NodeFormat.Random,
        ForwardedTransformActions action = ForwardedTransformActions.Set)
    {
        // ...
    }
}

ForwardedTransformExtensions.cs#L38-L39

Parameters

routeYarpRoute

useHostbooloptional

useProtobooloptional

forFormatNodeFormatoptional

byFormatNodeFormatoptional

actionForwardedTransformActionsoptional

WithTransformXForwarded(YarpRoute, string, ForwardedTransformActions, ForwardedTransformActions?, ForwardedTransformActions?, ForwardedTransformActions?, ForwardedTransformActions?)

extensionYarpRoute

Adds the transform which will add X-Forwarded-* headers.

public static class ForwardedTransformExtensions
{
    public static YarpRoute WithTransformXForwarded(
        this YarpRoute route,
        string headerPrefix = "X-Forwarded-",
        ForwardedTransformActions xDefault = ForwardedTransformActions.Set,
        ForwardedTransformActions? xFor = null,
        ForwardedTransformActions? xHost = null,
        ForwardedTransformActions? xProto = null,
        ForwardedTransformActions? xPrefix = null)
    {
        // ...
    }
}

ForwardedTransformExtensions.cs#L27-L28

Parameters

routeYarpRoute

headerPrefixstringoptional

xDefaultForwardedTransformActionsoptional

xForForwardedTransformActions?optional

xHostForwardedTransformActions?optional

xProtoForwardedTransformActions?optional

xPrefixForwardedTransformActions?optional