The iPhone Wiki is no longer updated. Visit this article on The Apple Wiki for current information. |
Difference between revisions of "Apple Push Service Protocol"
(Mention apnspack protocol) |
(Old protocol had messages starting on 00, not 04) |
||
Line 1: | Line 1: | ||
iOS devices connect to Apple's push servers via port 5223. The protocol is proprietary and has nothing to do with XMPP (which uses the same port to establish SSL-encrypted client connections). The Push service protocol also uses SSL encryption. |
iOS devices connect to Apple's push servers via port 5223. The protocol is proprietary and has nothing to do with XMPP (which uses the same port to establish SSL-encrypted client connections). The Push service protocol also uses SSL encryption. |
||
− | As of iOS5, Apple uses a new push protocol. The same protocol is used on the Mac too. With iOS4, the protocol used message types <code> |
+ | As of iOS5, Apple uses a new push protocol. The same protocol is used on the Mac too. With iOS4, the protocol used message types <code>00</code> to <code>06</code>, while the new protocol uses message types <code>07</code> to <code>0f</code> and all fields have a type-length-value encoding. |
While every iOS version after that continued adding new message and field types, in iOS 12 <!-- maybe earlier --> there is ''another'' new push protocol known as "apnspack", which uses the same message and field types but encodes them in a completely different binary format. The client negotiates use of this new protocol with the protocol name "apns-pack-v1" in [[wikipedia:ALPN|ALPN]]. The apnspack format is not yet documented in this page. |
While every iOS version after that continued adding new message and field types, in iOS 12 <!-- maybe earlier --> there is ''another'' new push protocol known as "apnspack", which uses the same message and field types but encodes them in a completely different binary format. The client negotiates use of this new protocol with the protocol name "apns-pack-v1" in [[wikipedia:ALPN|ALPN]]. The apnspack format is not yet documented in this page. |
Revision as of 06:19, 24 April 2021
iOS devices connect to Apple's push servers via port 5223. The protocol is proprietary and has nothing to do with XMPP (which uses the same port to establish SSL-encrypted client connections). The Push service protocol also uses SSL encryption.
As of iOS5, Apple uses a new push protocol. The same protocol is used on the Mac too. With iOS4, the protocol used message types 00
to 06
, while the new protocol uses message types 07
to 0f
and all fields have a type-length-value encoding.
While every iOS version after that continued adding new message and field types, in iOS 12 there is another new push protocol known as "apnspack", which uses the same message and field types but encodes them in a completely different binary format. The client negotiates use of this new protocol with the protocol name "apns-pack-v1" in ALPN. The apnspack format is not yet documented in this page.
Contents
Message Structure
The format of the non-packed APNS protocol is as follows:
- 1 byte message type
- 4 byte payload length
- fields, all with
- 1 byte type
- 2 byte length
- value
Example:
07
message type (Connect)00 00 00 27
39 byte payload length01
1st field00 20
32 byte length8a 73 82 00 82 ac 91 32 88 b6 aa ef 90 91 65 ce 8a 73 82 00 82 ac 91 32 88 b6 aa ef 90 91 65 ce
value 1 (32-byte push token)
02
2nd field00 01
1 byte length01
value
Messages
07 Connect
- Direction: device to server
- message type:
07
- fields:
01
32-byte push token02
1 byte unknown (value01
)
08 Connect Response
- Direction: server to device
- message type:
08
- fields:
01
status (00
ok,02
some error)04
unknown (value10 00
)05
unknown (value00 02
)03
32-byte push token (optional), sent after05
field
09 Push Topics
- Direction: device to server
- message type:
09
- fields:
02
20-byte ID for enabled topic (like topic for push-enabled app or a specific iCloud service like Find My iPhone)03
20-byte ID for disabled topic
0A Push Notification
- Direction: server to device (for iMessage and possibly others too, also the other way round)
- message type:
0a
- fields:
01
recipient push token02
topic03
notification payload04
response token05
expiry (32-bit UNIX timestamp)06
timestamp (64-bit UNIX timestamp in nanoseconds)07
unknown (00
)
0B Push Notification Response
- Direction: server to device (for iMessage and possibly others too, also the other way round)
- message type:
0b
- fields:
04
response token08
status (00
ok,02
error)
0C Keep-Alive
- Direction: device to server
- message type:
0c
- fields:
01
connection method ("WiFi" or GSM MNC like "31038" for AT&T)02
iOS version, e.g. "5.0"03
iOS build number04
device model, e.g. "iPhone2,1"05
unknown (values like10
,15
or20
)
0D Keep-Alive Confirmation
- Direction: server to device
- message type:
0d
- no fields
0E No Storage
- Direction: server to device
- message type:
0e
- fields:
03
32-byte push token
0F Flush
- Direction: both
- message type:
0f
- fields:
- 2-byte integer indicating length of padding
- padding: NULL-bytes, typical lengths are 64, 128, 256, 512