Question

我的问题是如何在Google Developers Console中正确设置软件包名称和SHA-1证书指纹，以限制我的Android API密钥在我的应用中的使用。

如果我在“限制Android应用的使用限制”部分中没有设置任何内容，我对Google Translate API的请求就能正常运行。 API会正常响应状态代码200和我的预期结果。

但是当我使用Developers Console为我的应用程序指定包名称和SHA-1证书指纹时，我始终会收到403 Forbidden响应，如下所示：

HTTP/1.1 403 Forbidden
Vary: Origin
Vary: X-Origin
Content-Type: application/json; charset=UTF-8
Date: Sun, 29 Nov 2015 21:01:39 GMT
Expires: Sun, 29 Nov 2015 21:01:39 GMT
Cache-Control: private, max-age=0
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
Server: GSE
Alternate-Protocol: 443:quic,p=1
Alt-Svc: quic=":443"; ma=604800; v="30,29,28,27,26,25"
Content-Length: 729

{
 "error": {
  "errors": [
   {
    "domain": "usageLimits",
    "reason": "ipRefererBlocked",
    "message": "There is a per-IP or per-Referer restriction configured on your API key and the request does not match these restrictions. Please use the Google Developers Console to update your API key configuration if request from this IP or referer should be allowed.",
    "extendedHelp": "https://console.developers.google.com"
   }
  ],
  "code": 403,
  "message": "There is a per-IP or per-Referer restriction configured on your API key and the request does not match these restrictions. Please use the Google Developers Console to update your API key configuration if request from this IP or referer should be allowed."
 }
}

请求如下所示。请注意，请求中没有referer标头：

GET https://www.googleapis.com/language/translate/v2?key=XXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXXX&source=en&target=es&q=test HTTP/1.1
User-Agent: Dalvik/2.1.0 (Linux; U; Android 5.1.1; Nexus 6 Build/LVY48H)
Host: www.googleapis.com
Connection: Keep-Alive
Accept-Encoding: gzip

我假设错误消息指示包名称或SHA-1指纹问题，尽管它有关于“每IP或每个Referer限制”的消息。虽然浏览器密钥允许设置每个引用限制，但我使用Android密钥无处可设置每IP或每个Referer限制。

我确定我已在Google Developers Console中正确输入了包名称。我正在从Android清单文件中package标记的manifest属性中读取包名称。

我也确定我在Google Developers Console中正确设置了SHA-1指纹。我正在使用命令keytool -list -v -keystore /path/to/my/keystore从密钥库中读取此值。当我使用keytool -list -printcert -jarfile myAppName.apk从APK文件中读取它时，我得到相同的值。我正在使用adb安装相同的APK文件。

以下是我在开发者控制台中看到的内容：

我在运行Android的多台设备上测试了这个。我在wifi和蜂窝网络上得到错误响应，无论我是否代理流量。

当我从开发者控制台中删除限制时，该应用程序可以再次正常运行。

我在这里做错了什么？

注意：Several similar questions have been asked before，but {{3} } with no adequate。我不想使用浏览器密钥或完全取消限制。我想让使用限制正常工作。

Answer 1

您在Google Developer Console上为限制Android应用的api密钥使用所做的一切都可以。限制后，此API密钥仅接受来自您的应用程序的请求，其中包含指定包名称和SHA-1证书指纹。

那么Google如何知道您的ANDROID APP发送的请求？您必须在每个请求的标题中添加您的应用程序包名称和SHA-1（显然）。而且您不需要GoogleAuthUtil和GET_ACCOUNTS权限。

首先，获取您的应用SHA签名（您需要Guava库）：

/**
 * Gets the SHA1 signature, hex encoded for inclusion with Google Cloud Platform API requests
 *
 * @param packageName Identifies the APK whose signature should be extracted.
 * @return a lowercase, hex-encoded
 */
public static String getSignature(@NonNull PackageManager pm, @NonNull String packageName) {
    try {
        PackageInfo packageInfo = pm.getPackageInfo(packageName, PackageManager.GET_SIGNATURES);
        if (packageInfo == null
                || packageInfo.signatures == null
                || packageInfo.signatures.length == 0
                || packageInfo.signatures[0] == null) {
            return null;
        }
        return signatureDigest(packageInfo.signatures[0]);
    } catch (PackageManager.NameNotFoundException e) {
        return null;
    }
}

private static String signatureDigest(Signature sig) {
    byte[] signature = sig.toByteArray();
    try {
        MessageDigest md = MessageDigest.getInstance("SHA1");
        byte[] digest = md.digest(signature);
        return BaseEncoding.base16().lowerCase().encode(digest);
    } catch (NoSuchAlgorithmException e) {
        return null;
    }
}

然后，将包名称和SHA证书签名添加到请求标头：

java.net.URL url = new URL(REQUEST_URL);
HttpURLConnection connection = (HttpURLConnection)url.openConnection();
try {
    connection.setDoInput(true);
    connection.setDoOutput(true);

    connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");
    connection.setRequestProperty("Accept", "application/json");

    // add package name to request header
    String packageName = mActivity.getPackageName();
    connection.setRequestProperty("X-Android-Package", packageName);
    // add SHA certificate to request header
    String sig = getSignature(mActivity.getPackageManager(), packageName);
    connection.setRequestProperty("X-Android-Cert", sig);
    connection.setRequestMethod("POST");

    // ADD YOUR REQUEST BODY HERE
    // ....................
} catch (Exception e) {
    e.printStackTrace();
} finally {
    connection.disconnect();
}

其他方式，如果您使用的是Google Vision API，则可以使用VisionRequestInitializer制作您的请求：

try {
    HttpTransport httpTransport = AndroidHttp.newCompatibleTransport();
    JsonFactory jsonFactory = GsonFactory.getDefaultInstance();

    VisionRequestInitializer requestInitializer =
    new VisionRequestInitializer(CLOUD_VISION_API_KEY) {
    /**
         * We override this so we can inject important identifying fields into the HTTP
         * headers. This enables use of a restricted cloud platform API key.
         */
        @Override
        protected void initializeVisionRequest(VisionRequest<?> visionRequest)
            throws IOException {
            super.initializeVisionRequest(visionRequest);

            String packageName = mActivity.getPackageName();
            visionRequest.getRequestHeaders().set("X-Android-Package", packageName);

            String sig = getSignature(mActivity.getPackageManager(), packageName);
            visionRequest.getRequestHeaders().set("X-Android-Cert", sig);
        }
    };

    Vision.Builder builder = new Vision.Builder(httpTransport, jsonFactory, null);
    builder.setVisionRequestInitializer(requestInitializer);

    Vision vision = builder.build();

    BatchAnnotateImagesRequest batchAnnotateImagesRequest =
    new BatchAnnotateImagesRequest();
    batchAnnotateImagesRequest.setRequests(new ArrayList<AnnotateImageRequest>() {{
    AnnotateImageRequest annotateImageRequest = new AnnotateImageRequest();

    // Add the image
    Image base64EncodedImage = new Image();
    // Convert the bitmap to a JPEG
    // Just in case it's a format that Android understands but Cloud Vision
    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
    requestImage.compress(Bitmap.CompressFormat.JPEG, IMAGE_JPEG_QUALITY, byteArrayOutputStream);
    byte[] imageBytes = byteArrayOutputStream.toByteArray();

    // Base64 encode the JPEG
    base64EncodedImage.encodeContent(imageBytes);
    annotateImageRequest.setImage(base64EncodedImage);

    // add the features we want
    annotateImageRequest.setFeatures(new ArrayList<Feature>() {{
    Feature labelDetection = new Feature();
    labelDetection.setType(TYPE_TEXT_DETECTION);
    add(labelDetection);
    }});

    // Add the list of one thing to the request
    add(annotateImageRequest);
    }});

    Vision.Images.Annotate annotateRequest =
    vision.images().annotate(batchAnnotateImagesRequest);
    // Due to a bug: requests to Vision API containing large images fail when GZipped.
    annotateRequest.setDisableGZipContent(true);
    Log.d("TAG_SERVER", "created Cloud Vision request object, sending request");

    BatchAnnotateImagesResponse response = annotateRequest.execute();
        return convertResponseToString(response);
    } catch (GoogleJsonResponseException e) {
        Log.d("TAG_SERVER", "failed to make API request because " + e.getContent());
    } catch (IOException e) {
        Log.d("TAG_SERVER", "failed to make API request because of other IOException " +
        e.getMessage());
}

将以下依赖项添加到您的gradle：

compile 'com.google.apis:google-api-services-vision:v1-rev2-1.21.0'
compile 'com.google.api-client:google-api-client-android:1.20.0' exclude module: 'httpclient'
compile 'com.google.http-client:google-http-client-gson:1.20.0' exclude module: 'httpclient'

希望这有帮助：）

Answer 2

使用仅限Google REST的API（例如翻译）时，您需要使用GoogleAuthUtil，这将为特定用户和包/指纹生成令牌。但是，这需要GET_ACCOUNTS权限，智能用户需要谨慎。

您还可以使用AccountManager的{{1}}方法，但这不仅需要getAuthToken()权限，还需要GET_ACCOUNTS。

您可能最好使用API密钥并稍微模糊一下。

Answer 3

打包限制和网址签名

当我为限制反向地理编码和静态地图api的访问而苦苦挣扎时，我遇到了这篇文章。我也想分享我的发现。

请注意，并非所有的Google服务都允许相同的限制。

我们使用url签名和android / ios软件包限制。 Link to the Google documentation

获取APK指纹

有多种方法可以从android apk获取指纹。

带有密钥库

keytool -list -v keystore mystore.keystore

带有APK

extract *.apk
navigate to folder META-INF
keytool.exe" -printcert -file *.RSA

C＃示例代码（Xamarin）入门

在我的生产代码中，我有Headerinfo的基类，并为Geoprovider类提供了实例。通过这种方法，可在Windows，Android和ios => nuget软件包之间100％共享Google服务的代码。

Android标头

httpWebRequest.Headers["x-android-package"] = "packageName";
httpWebRequest.Headers["x-android-package"] = "signature";

IOS标头

httpWebRequest.Headers["x-ios-bundle-identifier"] = "bundleIdentifier";

获取静态地图的示例代码

public byte[] GenerateMap(double latitude, double longitude, int zoom, string size, string mapType)
{
    string lat = latitude.ToString(CultureInfo.InvariantCulture);
    string lng = longitude.ToString(CultureInfo.InvariantCulture);
    string url = $"https://maps.googleapis.com/maps/api/staticmap?center={lat},{lng}&zoom={zoom}&size={size}&maptype={mapType}&markers={lat},{lng}&key={_apiKey}";

    // get the secret from your firebase console don't create always an new instance in productive code
    string signedUrl = new GoogleUrlSigner("mysecret").Sign(url);

    HttpWebRequest httpWebRequest = (HttpWebRequest)WebRequest.Create(signedUrl);

    //Add your headers httpWebRequest.Headers...

    // get the response for the request
    HttpWebResponse httpWebResponse = (HttpWebResponse)httpWebRequest.GetResponse();

    // do whatever you want to do with the response
}

谷歌提供的URL签名示例代码

https://developers.google.com/maps/documentation/geocoding/get-api-key

internal class GoogleUrlSigner
{
    private readonly string _secret;

    public GoogleUrlSigner(string secret)
    {
        _secret = secret;
    }

    internal string Sign(string url)
    {
        ASCIIEncoding encoding = new ASCIIEncoding();

        // converting key to bytes will throw an exception, need to replace '-' and '_' characters first.
        string usablePrivateKey = _secret.Replace("-", "+").Replace("_", "/");
        byte[] privateKeyBytes = Convert.FromBase64String(usablePrivateKey);

        Uri uri = new Uri(url);
        byte[] encodedPathAndQueryBytes = encoding.GetBytes(uri.LocalPath + uri.Query);

        // compute the hash
        HMACSHA1 algorithm = new HMACSHA1(privateKeyBytes);
        byte[] hash = algorithm.ComputeHash(encodedPathAndQueryBytes);

        // convert the bytes to string and make url-safe by replacing '+' and '/' characters
        string signature = Convert.ToBase64String(hash).Replace("+", "-").Replace("/", "_");

        // Add the signature to the existing URI.
        return uri.Scheme + "://" + uri.Host + uri.LocalPath + uri.Query + "&signature=" + signature;
    }
}

Answer 4

直接从代码中获取API，而不通过Google提供的中间SDK意味着没有可用的机制来安全地获取应用的证书指纹并将该指纹传递给API。另一方面，当您使用提供的Android SDK之一而不是直接访问API时（例如，当您使用Android Google Maps SDK发送请求时），SDK可以处理获取应用程序的证书指纹，以便该应用程序限制将按预期工作。

Google Developers Console在这方面具有误导性，因为对于它的某些API，它允许开发人员根据Android应用程序证书指纹来设置密钥限制，但随后却无法提供能够在运行时检查指纹。因此，开发人员所剩下的是更糟糕，更不安全的选项，即按此处另一个答案中的说明发送X-Android-Cert和X-Android-Package标头以及他们的请求。

因此，对于尚未发布用于处理应用程序证书指纹检查的任何随附Android SDK的API，事实证明，没有隐藏的简便方法来获取诸如Google Play服务之类的处理应用程序证书的方法指纹以正确使用应用程序密钥限制-只是没有办法。

Answer 5

如果您使用 appBundle 而不是普通的 apk 文件，您还需要从 play.google.com/console/ 获取 SHA-1：

然后将它与您的包一起添加到 console.developers.google.com/apis/credentials

希望它能为某人省心...

限制Google API的Android密钥使用情况

5 个答案: