Ограничение моих конечных точек с API-ключом в Java - PullRequest
Новая
       33

Ограничение моих конечных точек с API-ключом в Java

0 голосов
/ 24 августа 2018

Я использую облачные конечные точки v2 для Java. Моя проблема в том, что любой может получить доступ к этому методу конечных точек через API Explorer или напрямую URL , кто-то знает. Я хочу защитить свои конечные точки. Я прочитал документацию, как ограничить весь API или некоторые методы с помощью API KEY . Ограничение доступа к API с помощью ключей API

Вот то, что я пытаюсь. 

@Api(
        name = "zeem",
        version = "v1"
)

public class Account {
@ApiMethod(name = "getRegistration", path = "getRegistration", apiKeyRequired = AnnotationBoolean.TRUE)
public Registered getRegistration(@Named("phone") Long phone){
  // code ....
}

Я могу запустить этот метод без ключа API, и он успешно работает.
Даже я пытаюсь получить доступ к этому методу непосредственно из URL, он также работает. 

http://localhost:8080/_ah/api/zeem/v1/getRegistration?phone=123 // Successfully getting response

Пожалуйста, дайте мне знать, что я делаю не так. Есть что-то, по чему я скучаю?

Обновление - OpenAPI Doc

Да, я добавляю Управление API Вот как openapi.json выглядит для этой функции. 

    "/zeem/v1/getRegistration": {
   "get": {
    "operationId": "ZeemGetRegistration",
    "parameters": [
     {
      "name": "phone",
      "in": "query",
      "required": true,
      "type": "integer",
      "format": "int64"
     }
    ],
    "responses": {
     "200": {
      "description": "A successful response",
      "schema": {
       "$ref": "#/definitions/Registered"
      }
     }
    },
    "security": [
     {
      "api_key": [ ]
     }
    ]
   }
  },

Вот как выглядит консоль.

enter image description here

Чего мне не хватает?

Обновление: Web.xml 

<?xml version="1.0" encoding="utf-8"?>
<!-- [START_EXCLUDE] -->
<!--
  Copyright 2016 Google Inc.
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
        http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!-- [END_EXCLUDE] -->
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">

  <welcome-file-list>
    <welcome-file>welcome</welcome-file>
  </welcome-file-list>

  <!-- OBJECTIFY -->
  <filter>
    <filter-name>ObjectifyFilter</filter-name>
    <filter-class>com.googlecode.objectify.ObjectifyFilter</filter-class>
  </filter>
    <filter-mapping>
        <filter-name>ObjectifyFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

  <!-- ENDPOINTS -->
  <servlet>
        <servlet-name>EndpointsServlet</servlet-name>
        <servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
        <init-param>
            <param-name>services</param-name>
            <param-value>
                org.octabyte.zeem.API.Account,
                org.octabyte.zeem.API.CommentApi,
                org.octabyte.zeem.API.FriendApi,
                org.octabyte.zeem.API.ListApi,
                org.octabyte.zeem.API.PostApi,
                org.octabyte.zeem.API.SearchApi,
                org.octabyte.zeem.API.UserApi,
                org.octabyte.zeem.API.StoryApi
            </param-value>
        </init-param>
    </servlet>
    <!-- Route API method requests to the backend. -->
    <servlet-mapping>
        <servlet-name>EndpointsServlet</servlet-name>
        <url-pattern>/_ah/api/*</url-pattern>
    </servlet-mapping>


    <!-- Security -->
    <security-role>
        <role-name>admin</role-name>
    </security-role>
    <security-constraint>
        <web-resource-collection>
            <web-resource-name>admin</web-resource-name>
            <url-pattern>/*</url-pattern>
        </web-resource-collection>
        <auth-constraint>
            <role-name>admin</role-name>
        </auth-constraint>
    </security-constraint>

</web-app>

1 Ответ

0 голосов
/ 25 августа 2018

Существует недоразумение относительно ограничения доступа к ключам API. ограничение ключа API заключается в ограничении доступа к API-интерфейсам, к которым ключ имеет доступ, оно никоим образом не связано с аутентификацией пользователей.

Существует несколько способов аутентификации ваших пользователей.например, для конечных точек можно использовать управление API или использовать OpenAPI .

...