de.onyxbits.raccoon.finsky

Class CheckinApi

java.lang.Object

de.onyxbits.raccoon.finsky.CheckinApi

public class CheckinApi
extends java.lang.Object

This API does two things:

• Register new GSF IDs
• Regularly contact Play and send statistical data.

The GSF ID is basically a supercookie that identifies a given user on a given device. It is, functionwise, the successor to the Android ID and unlike the Android ID, server side generated (for that reason, GSF ID and Android ID are often used synonymously. They serve the same function, but have different origins).

Real devices are suppose to regularly send statistical data to Play (about once per half an hour). The data consists of things like the device's profile, the networks, it is currently connected to and identifying information like the serial number. In other words: one massive privacy violation, that happens without the user's knowledge or consent. This class implements the checkin api endpoint anyway for the purpose of keeping the GSF ID from going stale.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SETTLE How long to wait (in milliseconds) after binding a new GSF ID.

Constructor Summary

Constructors

Constructor and Description
CheckinApi(ClientProvider cp, RequestContextProvider rcp)
CheckinApi(org.apache.hc.client5.http.classic.HttpClient client, org.apache.hc.core5.http.Header... headers) Convenience constructor that wraps client in a DefaultClientProvider and headers in a DefaultRequestContextProvider.

Method Summary

Modifier and Type	Method and Description
de.onyxbits.raccoon.proto.AndroidCheckinResponse	requestBindId(java.util.Locale locale, java.util.TimeZone timezone, Device device, java.lang.String uid, java.lang.String auth, long gsfId, long securityToken) Bind the GSF ID.
de.onyxbits.raccoon.proto.AndroidCheckinResponse	requestCheckin(java.util.Locale locale, java.util.TimeZone timezone, Device device, long gsfId, long securityToken, long lastCheckin) Android devices are suppose to check in about twice per hour and tell Google how they are doing.
de.onyxbits.raccoon.proto.AndroidCheckinResponse	requestId(java.util.Locale locale, java.util.TimeZone timezone, Device device) Ask for a new GSF ID to be issued.
CheckinApi	withCellOperator(java.lang.String mccmnc) https://en.wikipedia.org/wiki/Mobile_country_code
CheckinApi	withSimOperator(java.lang.String mccmnc) https://en.wikipedia.org/wiki/Mobile_country_code

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SETTLE

public static final int SETTLE

How long to wait (in milliseconds) after binding a new GSF ID.

See Also:

Constant Field Values

Constructor Detail

CheckinApi

public CheckinApi(org.apache.hc.client5.http.classic.HttpClient client,
                  org.apache.hc.core5.http.Header... headers)

Convenience constructor that wraps client in a DefaultClientProvider and headers in a DefaultRequestContextProvider.

Parameters:

client - client for making requests.

headers - headers to add when making a request.

CheckinApi

public CheckinApi(ClientProvider cp,
                  RequestContextProvider rcp)

Parameters:

cp - where to get the HttpClient instance from when a request method is called.

rcp - called on every request to get headers.

Method Detail

withSimOperator

public CheckinApi withSimOperator(java.lang.String mccmnc)

https://en.wikipedia.org/wiki/Mobile_country_code

Parameters:

mccmnc - may be null.

Returns:

this reference for chaining.

withCellOperator

public CheckinApi withCellOperator(java.lang.String mccmnc)

https://en.wikipedia.org/wiki/Mobile_country_code

Parameters:

mccmnc - may be null.

Returns:

this reference for chaining.

requestId

public de.onyxbits.raccoon.proto.AndroidCheckinResponse requestId(java.util.Locale locale,
                                                                  java.util.TimeZone timezone,
                                                                  Device device)
                                                           throws java.io.IOException

Ask for a new GSF ID to be issued. It must be bound afterwards.

Parameters:

locale -

timezone -

device -

Returns:

a response containing a new GSF ID.

Throws:

java.io.IOException

requestBindId

public de.onyxbits.raccoon.proto.AndroidCheckinResponse requestBindId(java.util.Locale locale,
                                                                      java.util.TimeZone timezone,
                                                                      Device device,
                                                                      java.lang.String uid,
                                                                      java.lang.String auth,
                                                                      long gsfId,
                                                                      long securityToken)
                                                               throws java.io.IOException

Bind the GSF ID. Important: do not try use the new GSF ID right away! Play needs 1-2 seconds to settle.

Parameters:

locale -

timezone -

device -

uid -

auth -

gsfId -

securityToken -

Returns:

can be ignored.

Throws:

java.io.IOException

requestCheckin

public de.onyxbits.raccoon.proto.AndroidCheckinResponse requestCheckin(java.util.Locale locale,
                                                                       java.util.TimeZone timezone,
                                                                       Device device,
                                                                       long gsfId,
                                                                       long securityToken,
                                                                       long lastCheckin)
                                                                throws java.io.IOException

Android devices are suppose to check in about twice per hour and tell Google how they are doing. This is a serious violation of the user's privacy on real devices, as they constantly report back to which networks they are connected. The only reason to do it anyway is to keep the session from expiring.

Parameters:

locale -

timezone -

device -

lastCheckin - last checkin since the epoch

Returns:

server response

Throws:

java.io.IOException