How-tos

Protecting APIs on Apigee Edge Gateway

Instructions on how to discover, integrate and protect your APIs deployed behind the Apigee Edge gateway.

Prerequisites

Entitlements

Apigee Edge Authorizer has two features which require access to Apigee Edge API.

  • API discovery

    API discovery works by grouping and converting a list of Apigee Edge products into a format required by Cloudentity. The product list is obtained from the Apigee Edge API. To make it work, the configured user must have access to the product list.

  • Shared Flow installation

    Shared flow installation works by uploading a compressed package to Apigee Edge. If the shared flow already exist, a new revision is created. To make it work, the configured user must have a built-in Organization Administrator role.

Apigee Edge and SAML

Apigee Edge Authorizer, with its API discovery capabilities and a possibility to install a shared flow within your Apigee Gateway instance, exists with your Apigee Edge instance in a machine to machine environment. The authorizer does the automation for you. Because of that, when SAML is enabled for your Apigee Edge Gateway, it is not possible to use traditional password flow for SAML users to obtain OAuth2 access and refresh tokens.

To make it possible for you to authenticate your machine (in this case, the Apigee Edge Authorizer) when using SAML, Apigee Edge introduces the concept of machine users. Such users can obtain OAuth2 tokens for your authorizer without a need to specify a passcode and they are stored within your Edge datastore, not your SAML identity provider. You can limit access for such users, but make sure that the user you create for authorizer’s needs has access to the product list and has the Organization Administrator role built-in. Credentials of your machine user are later on provided in your authorizer’s docker-compose.yaml file.

Learn More

You can learn more about machine users and how to create them in Using SAML with automated tasks Apigee Edge documentation

Integrate Apigee Authorizer with Apigee Edge

Create Apigee Edge Authorizer

  1. Log in to your Cloudentity tenant.

  2. Open your authorization server (workspace).

  3. Go to Enforcement -> Authorizers.

  4. Select Add Gateway. A list of available gateways appears.

  5. Select Apigee Edge. Provide the name and description.

  6. Optionally, enable the Create and bind services automatically check box.

    Tip

    When enabled, all services protected by your Apigee Edge instance are discovered and added to the Cloudentity service list automatically when the Apigee authorizer is connected to Cloudentity. Otherwise, you need to add them manually.

  7. Follow the Quick Start instruction. Download the package from your tenant and check the Integrate Cloudentity and Apigee Edge instructions.

Integrate Cloudentity and Apigee Edge Authorizer

  1. Unzip the package and open the docker-compose.yaml file.

  2. Edit the following parameters to match your Apigee Edge instance:

    • APIGEE.APIGEE_EDGE.USERNAME=username - replace with your username

    • APIGEE.APIGEE_EDGE.PASSWORD=password - replace with your password

    • APIGEE.APIGEE_EDGE.ORGANIZATION_ID=org-id - replace with your organization ID

    version: '3'
    
    services:
    apigee-authorizer:
        container_name: apigee-edge-authorizer
        image: docker.cloudentity.io/apigee-authorizer:1.13.0
        env_file: .authorizer_env
        environment:
        - APIGEE.APIGEE_PRODUCT=ApigeeEdge
        - APIGEE.ACP_RELOAD_INTERVAL=5s # for demo purposes only, increase for production!
        - APIGEE.APIGEE_EDGE.USERNAME=username
        - APIGEE.APIGEE_EDGE.PASSWORD=password
        - APIGEE.APIGEE_EDGE.ORGANIZATION_ID=org-id
        ports:
        - 8442:8442
        restart: on-failure
    

    Tip

    The APIGEE.ACP_RELOAD_INTERVAL configuration parameter defines how often Cloudentity tries to discover APIs on your gateway.

    Save your changes when done.

  3. Run the docker-compose run apigee-authorizer install command in your terminal.

    Result

    When you run the command, a shared Authorizer flow is created automatically for you in your Apigee Edge instance. The shared flow consists of two policies:

    • A JavaScript Cloudentity Authorizer Policy that is responsible for communicating with the Apigee Edge Authorizer and for blocking/allowing the request depending on the Authorizers decision.

    • An XML Raise Authorization Error policy that is responsible for delivering the error status as the response to the unauthorized call to the protected API.

  4. Run docker-compose up. After a short while, Apigee Edge authorizer should be running.

    docker-compose up
    Creating apigee-edge-authorizer ... done
    Attaching to apigee-edge-authorizer
    apigee-edge-authorizer | time="2021-08-27T13:37:53Z" level=info msg="starting apigee authorizer" commit=289e388 version=1.13.0
    apigee-edge-authorizer | time="2021-08-27T13:37:54Z" level=info msg="apigee-authorizer listening on https://localhost:8442"
    
  5. Go to *Enforcement -> Authorizers > your_gateway > APIs. You should see a familiar list of services deployed using Apigee Edge.

    Note

    If you do not see a list of services deployed on Apigee Edge, make sure that at least one API Product is defined in your Apigee Edge organization with a connected API proxy.

    Note

    If you need to limit the count of discovered APIs, you can configure product_name_regexp or environment_name_regexp. Setting it up will limit discovered APIs to matching names.

  6. Select Connect > Create new service on a protected API from the list to add it to a list of Cloudentity-protected services. Give this new Cloudentity service a name when prompted.

    Note

    If you selected the Create and bind services automatically option when creating the gateway, your services are bound already.

    Result

    Your Apigee Edge-protected API is now on the list of Cloudentity-protected services.

  7. Deploy your Apigee Edge authorizer so that it is available publicly.

    Tip

    So far, you have only deployed your Apigee Edge authorizer locally using the Docker image provided by Cloudentity. You must expose it publicly as it is needed later on for the integration to work. For testing purposes, you can use tools like, for example, ngrok that expose local servers behind NATs and firewalls to public internet over secure channels.

Configure Apigee Edge Gateway

With Apigee Edge Gateway, you can define policies that are an Edge components that you can attach to different points in the message flow through your API proxies. Such policies can transform the message format, call remote services, and more. To protect your APIs, elevate the integration between Cloudentity and the Apigee Edge platform. Doing so allows you to enforce access control using Apigee Edge policies and Cloudentity authorization policies.

  1. In your Apigee Edge API Proxy settings, go to the DEVELOP tab.

  2. In the Navigator > Policies add a policy of the Flow Callout type.

    Tip

    You can find the Flow Callout policy type under the EXTENSTION tree node.

  3. Provide a name and a display name for your policy.

  4. As a shared flow, use the Authorizer shared flow.

    Result

    Your policy is created. It is defined with the following XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <FlowCallout async="false" continueOnError="false" enabled="true" name="Flow-Callout">
      <DisplayName>Flow Callout</DisplayName>
      <FaultRules/>
      <Properties/>
      <SharedFlowBundle>Authorizer</SharedFlowBundle>
    </FlowCallout>
    
  5. Configure your policy so that it points to your Apigee Edge authorizer’s /authorize endpoint that you have deployed in the seventh step of the Integrate Cloudentity and Apigee Edge section

    Example

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <FlowCallout async="false" continueOnError="false" enabled="true" name="microPerimeter">
       <DisplayName>microPerimeter</DisplayName>
       <FaultRules/>
       <Properties/>
       <Parameters>
           <Parameter name="authorizer_url">https://yourAuthorizerURL/authorize</Parameter>
           <Parameter name="proxy_body">false</Parameter>
       </Parameters>
       <SharedFlowBundle>Authorizer</SharedFlowBundle>
    </FlowCallout>
    

    proxy_body Parameter

    If the proxy_body parameter is set to true, the shared flow policy proxies the request body to the authorizer and then to the policies. Thanks to that it is possible to create policies that reject requests based on the request body. The request body must be in the JSON format.

    The proxy_body option is disabled by default to make it possible to use bigger-sized request bodies, for example, for image uploads.

  6. Add your new policy as a <step> element to your Proxy Endpoints PreFlows.

    Example

    <PreFlow name="PreFlow">
       <Request>
           <Step>
               <Name>microPerimeter</Name>
           </Step>
       </Request>
       <Response/>
    </PreFlow>
    

    Note

    You have to add your new policy to your Proxy Endpoints PreFlows, as the authorization must take place before the request reaches to target endpoint.

  7. Select Save.

Apply Sample Policy

  1. In Cloudentity, create a policy.

  2. Select Enforcement > APIs from the left sidebar.

  3. Select a service protected by the Apigee Edge authorizer and any API with authorization status Unrestricted.

  4. In the popup window, select Policy from the dropdown list and click Save to proceed.

Result

You have successfully assigned a policy to your API.

Test Integration

To test if your integration was successfull and that your APIs are protected, you can, for example, create a simple Cloudentity or REGO policy that will always pass. Call your protected endpoint and check if the response contains the successfull status. If yes, change your policy so that it blocks APIs. The next request to your protected enpoint should end with the unauthorized access error.

Troubleshooting

HTTP 403 Status Codes

  • Check your Apigee username, password and organization_id

  • Check if the configured user exists in a given Apigee organization

  • Check if the user has an access necessary to perform a given operation

Discovery Command

To quickly check if Apigee Edge credentials are configured correctly, run a single API discovery pass:

docker-compose run apigee-authorizer discovery

The expected result is a log with a list of APIs required by Cloudentity.

Debug Flag

Apigee Edge authorizer is able to log all inbound and outbound traffic from the Apigee Edge API. These logs can be useful to debug connectivity problems. To enable it, the debug flag must be set to true. The flag can be set by using an environment variable or passed directly via a configuration file. The debug flag works with the start (default) and discovery commands.

APIGEE.APIGEE_EDGE.DEBUG=true

Warning

The debug logs contain sensitive information such as credentials.

Apigee Edge Authorizer Configuration Refrence

For Apigee Edge Authorizer, it is possible to adjust its configuration. Below you can see an example of how the reference.yaml file looks like for both authorizers:

 # acp
acp:
    reload_interval: 1m0s # reload interval
    reload_timeout: 30s # reload configuration timeout
    issuer_url: https://localhost:8443/sample/system # issuer url
    client_id: bqesdrc4m4co2s81mpu0 # client id
    client_secret: LH6mAb6PNljvjYMIF-A5RP2bElA5a5bnQah8sG0fsLA # client secret
    tenant_id: "" # tenant id
    server_id: "" # server id
# http client
http_client:
    timeout: 10s # http client timeout
    retry_wait_min: 0s # minimum time to wait between retries
    retry_wait_max: 0s # maximum time to wait between retries
    retry_max: 0 # maximum number of retries
    root_ca: "" # root ca that this client should trust (defaults to system root ca)
    insecure_skip_verify: false # disable cert verification
    disable_follow_redirects: false # disable follow redirects
    disable_retry: true # disable retry
# metrics
metrics:
    enabled: false # enable metrics endpoint
    port: 9000 # metrics endpoint port
# analytics
analytics:
    enabled: true # when enabled, events are sent to audit log
    # event format
    event_format:
        include_policy_output: false # when enabled, policy evaluation output is sent to audit log
    # sampling
    sampling:
        probability: 1 # Probability of an event to be published (0.0-1.0)
        batch_inverval: 1s # Max duration to wait for a batch to publish
        batch_limit: 100 # Max number of events in a batch
        limit: 5 # Max number of batches per second to be published
        timeout: 5s # Timeout for a single batch to send
        workers: 8 # Number of sending workers
# cache
cache:
    ttl: 10s # ttl
    max_size: 100 # max size
# logging config
logging:
    level: info # log level severity
# token echange config
token_exchange:
    enabled: false # enable token exchange
    # cache
    cache:
        ttl: 1m0s # ttl
        max_size: 1000 # max size
    # inject config (supported only for istio authorizer)
    inject:
        mode: "" # Defines what token should be sent to the target service when token is exchanged
        # headers config
        headers:
            exchanged_token: "" # Defines the name of the header that contains an exchanged token.
            original_token: "" # Defines the name of the header that contains an original token.
            strip_bearer: false # Allows to strip the bearer prefix in headers
# enforcement config
enforcement:
    allow_unknown: false # allow requests with no matching rule
# http server
http_server:
    port: 8442 # http port
    dangerous_disable_tls: false # diables TLS
    # certificate configuration
    certificate:
        password: "" # key passphrase
        cert_path: "" # path to the certificate PEM file
        key_path: "" # path to the key PEM file
        cert: "" # base64 encoded cert PEM
        key: "" # base64 encoded key PEM
        generated_key_type: ecdsa # type for generated key if cert and key are not provided (rsa or ecda)
    client_auth_type: 0 # client auth type
# apigee
apigee:
    product_name: ApigeeX # oneof ApigeeX or ApigeeEdge
    shared_flow_path: data # path to a directory with an apigee shared flow definition
    # service discovery configuration
    discovery:
        enabled: true # when true, API discovery is enabled
        # filters are used for limiting the number of discovered APIs
        filters:
            product_name_regexp: "" # filter discovered APIs by Apigee product name (whitelist)
            environment_name_regexp: "" # filter discovered APIs by Apigee environment name (whitelist)
    # apigee edge configuration, leave empty in case of ApigeeX
    apigee_edge:
        username: "" # username (email address format)
        password: "" # password
        organization_id: "" # organization name
        base_url: https://api.enterprise.apigee.com # URL of Apigee API
        token_url: https://login.apigee.com/oauth/token # URL of Apigee Authorization API
        use_token: true # when true, the client exchanges credentials for the token, when false it uses basic auth
        debug: false # dumps http traffic to Apigee API, useful for debugging connection issues

 

You can generate a reference configuration for your authorizer using the docker-compose run apigee-authorizer reference command.

You can use the reference configuration as a basis for your customization. You can omit settings for which the default configuration is satisfactory, specifying only the required values, which are the client ID, client secret, and issuer URL parameters like it is shown in the example below:

   environment:
     - ACP_RELOAD_INTERVAL=5s
     - APIGEE_APIGEE_PRODUCT=ApigeeEdge
     - APIGEE_APIGEE_EDGE_USERNAME=username
     - APIGEE_APIGEE_EDGE_PASSWORD=password
     - APIGEE_APIGEE_EDGE_ORGANIZATION_ID=org-id

Tip

Note that nested YAML settings can be accessed by joining uppercased names with underscores, as shown in the example above, where the APIGEE_APIGEE_EDGE_PASSWORD=password parameter is set.

Run Authorizer with a Configuration File

  1. Add a volumes parameter to your docker-compose.yml file:

    volumes:
    - /Path/To/Your/Authorizer/apigee-{your_authorizer_version}-authorizer:/apigee
    

    The {your_authorizer_version} variable can be set to either x or edge.

    volumes attaches the defined catalog (/Path/To/Your/Authorizer/apigee-{your_authorizer_version}-authorizer:/apigee) to your authorizer’s docker image and maps it to a catalog that, from now on, exists on your docker image (apigee). This is the place where your configuration is stored on your authorizer’s docker deployment.

  2. Use the --config option to specify the YAML file with your configuration. For example, assuming that you have created a apigee_edge_config.yaml file in your current directory, your docker run command would look like the following:

    docker-compose run apigee-authorizer --config=/apigee/apigee_edge_config.yaml
    

Client Authentication for Apigee Edge Authorizer

By default, the Apigee Edge Authorizer uses OAuth2 access tokens to authenticate itself to your Apigee Edge instance. It is defined using the use_token: true setting in the Apigee Edge Authorizer’s configuration. If you wish to use Basic Authentication, set it to false.

You can do this by, for example, by providing the APIGEE_APIGEE_EDGE_USE_TOKEN=false environment variable in the docker-compose.yml file responsible for your authorizer’s docker deployment.

Run Authorizer with Environment Variables in the docker-compose Run Command

To run the authorizer without providing the whole configuration file, you can provide the environment variables in your docker-compose run command. See example below:

docker-compose run apigee-authorizer -e APIGEE_ACP_CLIENT_ID={your_client_id} APIGEE_ACP_CLIENT_SECRET={your_client_secret}
Updated: Jul 11, 2022