API Key Authentication

Secure Your Spring Boot API with API Keys

The Zuplo API Gateway protects your backend API from unauthorized access, abuse, and overload. Add API key authentication to your Spring Boot API in minutes.

Secure Access

Authenticate every request before it reaches your backend.

Control Costs

Set rate limits and quotas to prevent runaway usage.

Ensure Reliability

Shield your backend from overload with traffic management.

How it works

The Zuplo API Gateway sits between your clients and your Spring Boot backend, providing a secure layer of protection and control.

Client

Zuplo API Gateway

Customer VPC

Backend

Step-by-step tutorial

It takes only a few minutes to put Zuplo in front of your Spring Boot backend, adding API key authentication, and configuring your origin to trust requests from Zuplo using shared secrets.

Create a Route in Zuplo

First, create a new route in your Zuplo project that will proxy requests to your Spring Boot backend. This route will be the entry point for your API consumers.

Learn how to create routes

📄 OpenAPI native. Import your existing OpenAPI spec to instantly create routes and power your API documentation .

Add API Key Authentication Policy

Add the API Key Authentication policy to your route. This policy validates incoming API keys and ensures only authorized consumers can access your API.

Adding API Key Authentication policy in Zuplo

API Key Authentication docs

🔐 Leaked key? No problem. As a GitHub Secret Scanning partner, Zuplo can automatically revoke exposed keys before they can be exploited.

Add Set Header Policy

Add the Set Header policy to your route. This policy sets the shared secret header on requests to ensure only requests from Zuplo are accepted by your API.

Set Header Policy docs

Secure Your Spring Boot API with the Shared Secret

Configure your Spring Boot backend to validate the shared secret header set by Zuplo. This ensures that only requests coming through your Zuplo gateway are accepted.

Java

 import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Arrays;

@Component
public class SharedSecretFilter extends OncePerRequestFilter {

    @Value("${shared.secret}")
    private String expectedSecret;

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {

        String secret = request.getHeader("X-Shared-Secret");

        if (expectedSecret == null) {
            response.sendError(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Server configuration error");
            return;
        }

        if (secret == null) {
            response.sendError(HttpStatus.UNAUTHORIZED.value(), "No secret provided");
            return;
        }

        try {
            if (!timingSafeEquals(secret, expectedSecret)) {
                response.sendError(HttpStatus.UNAUTHORIZED.value(), "Invalid secret");
                return;
            }
        } catch (NoSuchAlgorithmException e) {
            response.sendError(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Error validating secret");
            return;
        }

        filterChain.doFilter(request, response);
    }

    private boolean timingSafeEquals(String a, String b) throws NoSuchAlgorithmException {
        byte[] aBytes = a.getBytes();
        byte[] bBytes = b.getBytes();

        if (aBytes.length != bBytes.length) {
            return false;
        }

        MessageDigest digest = MessageDigest.getInstance("SHA-256");
        byte[] aDigest = digest.digest(aBytes);
        byte[] bDigest = digest.digest(bBytes);

        return Arrays.equals(aDigest, bDigest);
    }
}

// In your configuration class
import org.springframework.context.annotation.Bean;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.web.SecurityFilterChain;
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;

@EnableWebSecurity
public class SecurityConfig {

    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http, SharedSecretFilter sharedSecretFilter) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/protected").authenticated()
                .and()
            .addFilterBefore(sharedSecretFilter, UsernamePasswordAuthenticationFilter.class);
        return http.build();
    }
}

// Example controller
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;

@RestController
@RequestMapping("/protected")
public class ProtectedController {

    @GetMapping
    public String getProtectedResource() {
        return "Access granted";
    }
} 

Call Your API Through Zuplo

Now you can call your API through Zuplo using an API key. The request will be authenticated at the gateway, and securely forwarded to your Spring Boot backend.

bash

 curl -X GET \
  'https://your-api.zuplo.dev/your-route' \
  -H 'Authorization: Bearer YOUR_API_KEY' 

Ready to secure your API?

Get started with Zuplo for free and add API key authentication to your Spring Boot API in minutes.

Start for Free Read the Docs