355

How can you debug CORS requests using cURL? So far I couldn't find any way to "simulate" the preflight request .

themihai
  • 6,579
  • 11
  • 32
  • 53

4 Answers4

564

Here's how you can debug CORS requests using curl.

Sending a regular CORS request using cUrl:

curl -H "Origin: http://example.com" --verbose \
  https://www.googleapis.com/discovery/v1/apis?fields=

The -H "Origin: http://example.com" flag is the third party domain making the request. Substitute in whatever your domain is.

The --verbose flag prints out the entire response so you can see the request and response headers.

The url I'm using above is a sample request to a Google API that supports CORS, but you can substitute in whatever url you are testing.

The response should include the Access-Control-Allow-Origin header.

Sending a preflight request using cUrl:

curl -H "Origin: http://example.com" \
  -H "Access-Control-Request-Method: POST" \
  -H "Access-Control-Request-Headers: X-Requested-With" \
  -X OPTIONS --verbose \
  https://www.googleapis.com/discovery/v1/apis?fields=

This looks similar to the regular CORS request with a few additions:

The -H flags send additional preflight request headers to the server

The -X OPTIONS flag indicates that this is an HTTP OPTIONS request.

If the preflight request is successful, the response should include the Access-Control-Allow-Origin, Access-Control-Allow-Methods, and Access-Control-Allow-Headers response headers. If the preflight request was not successful, these headers shouldn't appear, or the HTTP response won't be 200.

You can also specify additional headers, such as User-Agent, by using the -H flag.

monsur
  • 39,509
  • 15
  • 93
  • 91
  • 2
    that page does not seem to return any CORS headers, is that correct? – Janus Troelsen Feb 24 '13 at 20:01
  • 1
    In order to view the actual headers, you need to add the `--verbose` option, as mentioned above. – monsur Feb 25 '13 at 14:24
  • Hmm, that may be a bug. Can you try the same request to the following url: http://server.cors-api.appspot.com/server?id=3349374&enable=true&status=200&credentials=false&methods=GET%2CPOST&headers=X-Requested-With – monsur Feb 25 '13 at 15:41
  • 1
    --verbose wasn't displaying headers for me either. I replaced it with "--trace-ascii -" – Bryan Larsen Sep 30 '13 at 15:00
  • 11
    or `--head`: `curl -H "Origin: http://example.com" --head https://www.googleapis.com/discovery/v1/apis\?fields\=` – John Bachir Apr 06 '14 at 05:30
  • 2
    Use --include to see the headers. – Mika Tuupola Feb 18 '16 at 16:18
  • 7
    In the case of S3, the according headers are only added if the proper method is given, you can do so by using `curl -H "Access-Control-Request-Method: GET" -H "Origin: http://example.com" -I https://s3.amazonaws.com/your-bucket/file`. – Joscha Mar 02 '16 at 02:13
72

Updated answer that covers most cases

curl -H "Access-Control-Request-Method: GET" -H "Origin: http://localhost" --head http://www.example.com/
  1. Replace http://www.example.com/ with URL you want to test.
  2. If response includes Access-Control-Allow-* then your resource supports CORS.

Rationale for alternative answer

I google this question every now and then and the accepted answer is never what I need. First it prints response body which is a lot of text. Adding --head outputs only headers. Second when testing S3 URLs we need to provide additional header -H "Access-Control-Request-Method: GET".

Hope this will save time.

greg0ire
  • 21,120
  • 15
  • 68
  • 95
Vilius Paulauskas
  • 2,647
  • 2
  • 21
  • 24
  • 2
    if I curl without setting origin and I can get response and headers(including access-control-allow-origin header) back, does that mean I set up my CORS incorrectly? curl -X GET 'https://www.endpoint.com' -H 'Cache-Control: no-cache' --head – Jun711 Jul 13 '18 at 00:23
  • 1
    This relies on `--head` making curl print out the headers, but it also makes curl make a `HEAD` request rather than a `GET`. Depending on what you're testing, you may want to make a `GET` request. You can do this by adding `--IXGET`. – Aidan Fitzpatrick Dec 05 '18 at 16:11
  • 3
    Isn't this backwards? Shouldn't the origin be example.com instead? – Dustin Ingram Apr 22 '19 at 18:43
5

The bash script "corstest" below works for me. It is based on Jun's comment above.

usage

corstest [-v] url

examples

./corstest https://api.coindesk.com/v1/bpi/currentprice.json
https://api.coindesk.com/v1/bpi/currentprice.json Access-Control-Allow-Origin: *

the positive result is displayed in green

./corstest https://github.com/IonicaBizau/jsonrequest
https://github.com/IonicaBizau/jsonrequest does not support CORS
you might want to visit https://enable-cors.org/ to find out how to enable CORS

the negative result is displayed in red and blue

the -v option will show the full curl headers

corstest

#!/bin/bash
# WF 2018-09-20
# https://stackoverflow.com/a/47609921/1497139

#ansi colors
#http://www.csc.uvic.ca/~sae/seng265/fall04/tips/s265s047-tips/bash-using-colors.html
blue='\033[0;34m'  
red='\033[0;31m'  
green='\033[0;32m' # '\e[1;32m' is too bright for white bg.
endColor='\033[0m'

#
# a colored message 
#   params:
#     1: l_color - the color of the message
#     2: l_msg - the message to display
#
color_msg() {
  local l_color="$1"
  local l_msg="$2"
  echo -e "${l_color}$l_msg${endColor}"
}


#
# show the usage
#
usage() {
  echo "usage: [-v] $0 url"
  echo "  -v |--verbose: show curl result" 
  exit 1 
}

if [ $# -lt 1 ]
then
  usage
fi

# commandline option
while [  "$1" != ""  ]
do
  url=$1
  shift

  # optionally show usage
  case $url in      
    -v|--verbose)
       verbose=true;
       ;;          
  esac
done  


if [ "$verbose" = "true" ]
then
  curl -s -X GET $url -H 'Cache-Control: no-cache' --head 
fi
origin=$(curl -s -X GET $url -H 'Cache-Control: no-cache' --head | grep -i access-control)


if [ $? -eq 0 ]
then
  color_msg $green "$url $origin"
else
  color_msg $red "$url does not support CORS"
  color_msg $blue "you might want to visit https://enable-cors.org/ to find out how to enable CORS"
fi
Wolfgang Fahl
  • 12,097
  • 9
  • 75
  • 150
  • adding the Origin header would make it better e g. *-H 'origin:https://mydomain.xyz'* – Bas Mar 16 '20 at 21:32
4

Seems like just this works:

curl -I http://example.com

Look for Access-Control-Allow-Origin: * in the returned headers

MalcolmOcean
  • 2,597
  • 2
  • 24
  • 36
  • 5
    Remember that `*` doesn't work if credentials such as a cookie need to be presented with the API request. In that case the FQDN is required in the `Access-Control-Allow-Origin` response as well as `Access-Control-Allow-Credentials: true`. Credentialed requests though weren't specified as a requirement by OP, so `*` works for any unauthenticated requests. – GameSalutes Jan 30 '19 at 18:04