This post discusses some of the more common reasons for why your app might encounter networking problems during App Review.
Not All Rejections Are IPv6 Related
The App Review rejection you’ve received indicates that:
your app failed
it was tested on an IPv6-only network
This does not mean that the failure was specifically caused by that network. There are many other reasons why an app can work in your office but fail during App Review. QA1764 How to reproduce bugs reported against App Store submissions outlines our standard steps for isolating problems like this.
App Review’s IPv6-only Network
App Review tests your app on an IPv6-only network that supports DNS64/NAT64. You can test your app in a similar way using an Internet Sharing-based DNS64/NAT64 test network. FAQ #1 of the Supporting IPv6-only Networks pinned post has links to the instructions for setting this up. You should make sure your app works on this test network before going any further.
This test network is not exactly the same as the network used by App Review. Later sections of this document discuss some of the potential pitfalls here.
Check All the Servers
When evaluating the IPv6 readiness of your app, it’s important to consider all of the servers it contacts. This may not be easy to determine. Some apps address many different servers for many different reasons (core functionality, secondary functionality, advertising, analytics, and so on). Moreover, it may not be easy for you to uncover all of these servers. For example:
server names may be hidden within library code
server names may be returned to your app as the result of other network requests
for HTTP and HTTPS servers, your app may start off talking to one server and be redirected to a different server
CNAMErecords mean that a server can have many aliases
One easy way to uncover all of the servers used by your app is to look at a CFNetwork diagnostic log:
enable CFNetwork diagnostic logging for your app
exercise your app in the usual way
grab the log and filter it to build a list of servers
IMPORTANT This approach works well if your app uses high-level networking APIs (anything based on CFSocketStream, including NSURLSession and NSURLConnection). It will not show any networking done using low-level networking APIs, like BSD Sockets. You will have to investigate such code manually.
The rest of this document assumes your app is talking to one server. If your app is talking to multiple servers, you’ll have to repeat the following steps for each one.
The Networking Overview says:
Note that, unlike DNS64/NAT64 workflows deployed by service providers, [the Internet Sharing-based test network] always generates synthesized IPv6 addresses. Therefore, it does not [connections] to IPv6-only servers outside of your local network.
The App Review network, like the networks deployed by service providers, does support IPv6-to-IPv6 connectivity. Thus, if your server supports IPv6, your app will talk to it directly, without going through the NAT64 translator.
This is, in general, a good thing, but it can trip you up if your server claims to support IPv6 but that IPv6 support is broken. For example, if:
the DNS name is incorrect
the DNS is correct but the server is not listening on IPv6
the server is listening on IPv6 but fails when a request comes in over IPv6
The following sections discuss each of these points in turn.
IPv6 DNS Problems
Your first step in debugging IPv6 connectivity should be to check that the DNS is returning reasonable results for your server’s name. You can do this using the
dig command line tool. The following is an example of the results you’d expect if your server supports IPv6.
$ dig +nocmd +nostats example.com AAAA ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 24342 ;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0 ;; QUESTION SECTION: ;example.com. IN AAAA ;; ANSWER SECTION: example.com. 66159 IN AAAA 2606:2800:220:1:248:1893:25c8:1946
dig is a flexible tool for interrogating DNS name servers.
dig does not use this system’s DNS resolver, but rather talks to the DNS server directly. In these examples I’m supplying the
+nostats arguments to minimise the noise in the output and
AAAA to query for an IPv6 address record.
As you can see, the server responds with a status of
NOERROR (line 3) and an Answer Section that contains the IPv6 address of the server. This indicates that the server claims to support IPv6.
In contrast, the following command shows the result to expect when the
AAAA record is not present.
$ dig +nocmd +nostats ipv4only.arpa AAAA ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 49883 ;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 0 ;; QUESTION SECTION: ;ipv4only.arpa. IN AAAA ;; AUTHORITY SECTION: ipv4only.arpa. 489 IN SOA sns.dns.icann.org. noc.dns.icann.org. …
Note that the status is still
NOERROR but there’s no Answer Section. This indicates that the server only supports IPv4. If that’s the case, you can skip the next few sections (move on to General DNS Problems) because your connections will always go through the NAT64 translator.
dig is showing any other sort of response, read the next few sections to see if you’ve hit one of the more common DNS problems.
Common DNS Problem:
One common DNS problem is illustrated by the example below:
$ dig +nocmd +nostats broken.example.com AAAA ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: SERVFAIL, id: 27593 ;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 0 ;; QUESTION SECTION: ;broken.example.com. IN AAAA
In this case the status (still on line 3) is
SERVFAIL. This indicates a failure on the server rather than the absence of an
AAAA record. If your DNS server incorrectly returns this status, it can cause problems for DNS64/NAT64 networks.
IMPORTANT Section 5.1.2 of RFC 6147 requires that a DNS64/NAT64 gateway treat a status of
SERVFAIL when requesting an
AAAA record as equivalent to
NOERROR. However, it’s possible that your app may be run on a DNS64/NAT64 network where the gateway does not handle this properly, so it’s best if your DNS server not return
SERVFAIL unless there’s an actual failure.
Common DNS Problem:
Another common DNS problem is illustrated by this example:
$ dig +nocmd +nostats broken.example.com AAAA ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 52961 ;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 0 ;; QUESTION SECTION: ;broken.example.com. IN AAAA
Again, the key thing to note here is the status (line 3). A status of
NXDOMAIN means that there are no records of any type for this name. You shouldn’t see this for your server’s name because that server should have an
A record containing its IPv4 address. Some DNS servers incorrectly return
NXDOMAIN when asked for an
AAAA record, even though there’s a valid
A record. A bug like this in your DNS server will cause problems for IPv6-only clients because the DNS64/NAT64 gateway takes the DNS server at its word: an
NXDOMAIN result for the
AAAA query means there is also no
A record, and thus the name is invalid.
Common DNS Problem: IPv4-Mapped Addresses
Finally, you should watch out for responses like this:
$ dig +nocmd +nostats broken.example.com AAAA ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 34278 ;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0 ;; QUESTION SECTION: ;example.com. IN AAAA ;; ANSWER SECTION: example.com. 66159 IN AAAA ::ffff:184.108.40.206
The DNS returned an
AAAA for the name but that record contains an IPv4-mapped address (these are shown as
x.x.x.x is a standard IPv4 address). Such an address is not valid in an
AAAA record and will cause problems for the DNS64/NAT64 gateway. You must reconfigure your server to either:
not claim to support IPv6, by removing the
natively supporting IPv6, by putting a real IPv6 address in the
If your server claims to support IPv6, you should make sure it’s listening on the IPv6 address returned by the DNS. If it’s a web server (HTTP or HTTPS), there are a variety of web-based tools to check this (for example, ipv6-test.com). If it’s some other sort of server, you will have to test this from a native IPv6 network.
IMPORTANT When testing a web server, make sure you know whether the server is being contacted by HTTP or HTTPS, and test the appropriate protocol.
IPv6 Server Failures
It’s possible that your server is correctly set up to use IPv6 but fails when it gets a request over IPv6. If you can read the server’s log, you might be able to use it to debug failures like this. If not, you will have to test your server from a native IPv6 network.
General DNS Problems
For DNS64/NAT64 to work properly, it’s important that your DNS servers are set up correctly. It’s easy for subtle DNS configuration errors to cause problems to show up in some circumstances, like on the App Review network, and not in others, like your Internet Sharing-based DNS64/NAT64 test network.
There are a variety of Internet-based tools you can use to check your DNS setup. Many of them are based on the DNSCheck code from The Internet Foundation In Sweden. While it’s possible to download and run this code yourself, it’s generally easier to use their online tool.
When checking DNS, be wary of the following:
DNS aliases (
domain names versus zones
The following sections explain these points in detail.
As mentioned earlier, DNS allows a server to have multiple aliases via
CNAME records. If the name you’re connecting to is a DNS alias, and the source and destination names are in different zones, you have to check each zone independently.
You can uncover these DNS aliases using
dig. For example, the following shows that
ftp.microsoft.com is actually a
ftp.microsoft.akadns.net., which in turn resolves to the IP address 220.127.116.11. On the other hand,
www.example.com directly points to 18.104.22.168.
$ dig +short ftp.microsoft.com ftp.microsoft.akadns.net. 22.214.171.124 $ dig +short www.example.com 126.96.36.199
In the case of
ftp.microsoft.com, the DNS alias means you have to be concerned with both the
microsoft.com. domain and the
Domain Names versus Zones
Some DNS checking tools will not let you enter an arbitrary domain name. Instead, you have to enter the domain name of the top of the zone. For example, you can’t check
www.example.com, but instead have to check
You can find the top of the zone by searching for an
SOA (Start of Authority) record. If you don’t get an
SOA record for the name, walk ‘up’ the DNS hierarchy, removing a label from the front of the name, until you do. The following example shows how to do this using
$ dig +short www.example.com SOA $ dig +short example.com SOA sns.dns.icann.org. noc.dns.icann.org. …
Once you have the top of the zone you can check the domain using whatever DNS checking tool you choose. The following is an example of running a check with the
dnscheck command line tool, which I built from the DNSCheck open source on my Mac.
$ /usr/local/bin/dnscheck example.com 0.000: example.com INFO Begin testing zone example.com with version 1.6.6. 0.001: example.com INFO Begin testing delegation for example.com. 17.579: example.com INFO Name servers listed at parent: a.iana-servers.net,b.iana-servers.net 22.148: example.com INFO Name servers listed at child: a.iana-servers.net,b.iana-servers.net …
dnscheck is not without its challenges. If you only have a few domains to check, it’s much easier to use IIS’s online tool.
Some developers have attempted to synthesise an IPv6 address by combining an IPv4 address with the Well-Known Prefix (64:ff9b::/96). This will not work in the general case. For reliable results you must use
getaddrinfo (or some higher-level API) to synthesise IPv6 addresses, as described in Use System APIs to Synthesize IPv6 Addresses.
For more advice on this front, see FAQ #4 in the Supporting IPv6-only Networks pinned post.
Quinn “The Eskimo!”
Apple Developer Relations, Developer Technical Support, Core OS/Hardware
let myEmail = "eskimo" + "1" + "@apple.com"
23 Jun 2016 — First posted.
22 Jul 2016 — Removed an incorrect mention of
NXDOMAINand added a more in-depth discussion of that status. Expanded the discussion of
SERVFAIL, adding a reference to Section 5.1.2 of RFC 6147. Made minor editoral changes.
23 Aug 2016 — The App Review DNS64/NAT64 gateway now handles
SERVFAILcorrectly; changed the discussion of that response code.
26 Sep 2016 — Specifically called out the issue with IPv4-mapped addresses in the DNS. Broke up the IPv6 DNS Problems section into subsections to make it easier to follow.