认证与授权接口设计

[sparrowzoo]

说明

实现基本功能

1. 登录token签名
2. 用户身份认证（验签）
3. 资源访问权限授权

不限于具体技术，支持Shiro+JWT实现，也可以自己实现，框架提供自实现抽象类（最少依赖）
https://github.com/sparrowzoo/sparrow-protocol/blob/develop/src/main/java/com/sparrow/protocol/AuthorizingSupport.java

接口定义如下：

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package com.sparrow.protocol;

/**
 * 认证授权接口
 * @author harry
 */
public interface AuthorizingSupport {
    /**
     * 签名(登录)
     *
     * @param login login token 
     * @return
     */
    String sign(LoginToken login);

    /**
     * 认证，需要验证当前token所在设备
     * 用户password 需要在token中解析
     * @param permission 
     * @return
     */
    LoginToken authenticate(String token, String deviceId);

    /**
     * 授权某资源
     *
     * @param user
     * @param url
     * @param code
     * @return
     * @throws BusinessException
     */
    boolean isAuthorized(LoginToken user,
                         String url, String code) throws BusinessException;
}

参考资料

1. https://jwt.io/introduction
   

2. https://shiro.apache.org

[sparrowzoo]

package com.sparrow.support;

import com.sparrow.constant.Config;
import com.sparrow.constant.ConfigKeyLanguage;
import com.sparrow.constant.User;
import com.sparrow.cryptogram.Base64;
import com.sparrow.cryptogram.Hmac;
import com.sparrow.protocol.AuthorizingSupport;
import com.sparrow.protocol.LoginToken;
import com.sparrow.utility.ConfigUtility;
import com.sparrow.utility.StringUtility;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.UnsupportedEncodingException;

import static com.sparrow.cryptogram.Base64.PREFERRED_ENCODING;

/**
 * @author: [email protected]
 * @date: 2019-04-06 17:54
 * @description:
 */
public abstract class AbstractAuthorizingService implements AuthorizingSupport {
    static Logger logger = LoggerFactory.getLogger(AbstractAuthorizingService.class);

    protected abstract String getSecret(Long userId);

    @Override
    public LoginToken authenticate(String permission, String deviceId) {
        LoginToken login = new LoginToken();
        login.setUserId(User.VISITOR_ID);
        login.setUserName(ConfigUtility.getLanguageValue(
                ConfigKeyLanguage.USER_VISITOR,
                ConfigUtility.getValue(Config.LANGUAGE)));
        login.setAvatar(ConfigUtility.getValue(Config.DEFAULT_AVATAR));
        if (StringUtility.isNullOrEmpty(permission)) {
            return login;
        }

        try {
            if (!permission.contains(".")) {
                return login;
            }
            String[] tokens = permission.split("\\.");
            //id=%1$s&name=%2$s&login=%3$s&expireAt=%4$s&cent=%5$s&avatar=%6$s&deviceId=%7$s&activate=%8$s
            String userInfo = tokens[0];
            String signature = tokens[1];

            userInfo = new String(Base64.decode(userInfo), PREFERRED_ENCODING);
            String[] userInfoArray = userInfo.split("&");
            String dev = userInfoArray[6].substring("deviceId=".length());
            //设备不一致
            if (!dev.equals(deviceId)) {
                return login;
            }

            String expireAtStr = userInfoArray[3].substring("expireAt=".length());
            long expireAt = 0L;
            //过期
            if (!StringUtility.isNullOrEmpty(expireAtStr) && !"null".equalsIgnoreCase(expireAtStr)) {
                expireAt = Long.parseLong(expireAtStr);
                if (System.currentTimeMillis() > expireAt) {
                    return login;
                }
            }

            Long userId = Long.parseLong(userInfoArray[0].substring("id=".length()));
            String newSignature = Hmac.getInstance().getSHA1Base64(userInfo,
                    this.getSecret(userId));

            //签名不一致
            if (!signature.equals(newSignature)) {
                return login;
            }
            login.setUserId(userId);
            login.setNickName(userInfoArray[1].substring("name="
                    .length()));
            login.setUserName(userInfoArray[2].substring("login=".length()));

            login.setCent(Long.valueOf(userInfoArray[4].substring("cent=".length())));
            login.setAvatar(userInfoArray[5].substring("avatar="
                    .length()));
            login.setDeviceId(dev);
            login.setExpireAt(expireAt);
            String activate = userInfoArray[7].substring("activate="
                    .length());
            if (!StringUtility.isNullOrEmpty(activate)) {
                login.setActivate(Boolean.valueOf(activate));
            }
            String days = userInfoArray[8].substring("days="
                    .length());
            if (!StringUtility.isNullOrEmpty(days)) {
                login.setDays(Integer.valueOf(days));
            }
            return login;
        } catch (Exception ignore) {
            logger.error("parser error ", ignore);
            return login;
        }
    }

    public String sign(LoginToken login) {
        String userInfo = String.format(
                "id=%1$s&name=%2$s&login=%3$s&expireAt=%4$s&cent=%5$s&avatar=%6$s&deviceId=%7$s&activate=%8$s&days=%9$s",
                login.getUserId(),
                login.getUserName(),
                login.getNickName(),
                login.getExpireAt(),
                login.getCent(),
                login.getAvatar(),
                login.getDeviceId(),
                login.getActivate(),
                login.getDays());
        String signature = Hmac.getInstance().getSHA1Base64(userInfo,
                this.getSecret(login.getUserId()));
        try {
            return Base64.encodeBytes(userInfo.getBytes(PREFERRED_ENCODING)) + "." + signature;
        } catch (UnsupportedEncodingException ignore) {
            return null;
        }
    }
}

抽象类实现