com.threerings.presents.server.ServiceAuthenticator Maven / Gradle / Ivy

Go to download
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2012 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.presents.server;

import java.lang.reflect.Constructor;

import com.threerings.util.Name;

import com.threerings.presents.data.AuthCodes;
import com.threerings.presents.net.AuthResponse;
import com.threerings.presents.net.AuthResponseData;
import com.threerings.presents.net.ServiceCreds;
import com.threerings.presents.server.net.AuthingConnection;

import static com.threerings.presents.Log.log;

/**
 * Works in conjunction with {@link ServiceCreds} to handle the authentication of service clients
 * (bureaus, peers, etc.).
 */
public abstract class ServiceAuthenticator extends ChainedAuthenticator
{
    /**
     * Creates an authenticator that will handle requests using the supplied credentials class and
     * which will create instances of the supplied auth name class to identify those clients. Note
     * that the auth name class must have a public constructor that takes a single string.
     */
    public ServiceAuthenticator (Class credsClass, Class authNameClass)
    {
        _credsClass = credsClass;
        try {
            _authNamer = authNameClass.getConstructor(String.class);
        } catch (NoSuchMethodException nsme) {
            throw new IllegalArgumentException("AuthName must have AuthName(String) constructor.");
        }
    }

    @Override // from abstract ChainedAuthenticator
    public boolean shouldHandleConnection (AuthingConnection conn)
    {
        return _credsClass.isInstance(conn.getAuthRequest().getCredentials());
    }

    @Override // from abstract Authenticator
    protected void processAuthentication (AuthingConnection conn, AuthResponse rsp)
        throws Exception
    {
        T creds = _credsClass.cast(conn.getAuthRequest().getCredentials());
        if (!areValid(creds)) {
            log.warning("Received invalid service auth request?", "creds", creds);
            throw new AuthException(AuthCodes.SERVER_ERROR);
        }

        try {
            conn.setAuthName(_authNamer.newInstance(creds.clientId));
            rsp.getData().code = AuthResponseData.SUCCESS;
        } catch (Exception e) {
            log.warning("Failed to construct auth name", "namer", _authNamer, e);
            throw new AuthException(AuthCodes.SERVER_ERROR);
        }
    }

    /**
     * Returns true if the creds in question are valid.
     */
    protected abstract boolean areValid (T creds);

    protected Class _credsClass;
    protected Constructor _authNamer;
}