org.ctoolkit.restapi.client.firebase.GoogleApiFirebaseModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ctoolkit-client-firebase Show documentation
Google API CtoolkiT Client Implementation of Google Firebase Auth
There is a newer version: 0.38
Show newest version
/*
 * Copyright (c) 2018 Comvai, s.r.o. All Rights Reserved.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.ctoolkit.restapi.client.firebase;

import com.google.auth.oauth2.GoogleCredentials;
import com.google.common.base.Strings;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseOptions;
import com.google.inject.AbstractModule;
import com.google.inject.Inject;
import com.google.inject.Provides;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.inject.Named;
import javax.inject.Singleton;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URL;

/**
 * The Google Firebase Admin based identity module.
 * The following properties are allowed to be configured via dependency injection:
 * 
 * credential.firebase.credentialOn
 * credential.firebase.fileName
 * credential.firebase.projectId
 * credential.firebase.databaseName
 * 
 * If credentialOn is true (by default is false) these properties become mandatory
 * and will be used to authenticate calls. If databaseName value is missing the projectId will be used.
 *
 * @author Aurel Medvegy
 */
public class GoogleApiFirebaseModule
        extends AbstractModule
{
    public static final String API_PREFIX = "firebase";

    private static final Logger logger = LoggerFactory.getLogger( GoogleApiFirebaseModule.class );

    @Override
    protected void configure()
    {
    }

    @Provides
    @Singleton
    IdentityHandler provideIdentityHandler( IdentityApiInit init )
            throws IOException
    {
        logger.info( "credential.firebase.credentialOn: " + init.credentialOn );
        logger.info( "credential.firebase.fileName:" + init.fileName );
        logger.info( "credential.firebase.projectId: " + init.projectId );
        logger.info( "credential.firebase.databaseName: " + init.databaseName );

        FirebaseOptions options;
        String databaseName = init.databaseName;
        String projectId = init.projectId;

        if ( Strings.isNullOrEmpty( databaseName ) && projectId != null )
        {
            databaseName = projectId;
        }

        if ( Strings.isNullOrEmpty( databaseName ) )
        {
            String msg = "The property 'credential.firebase.databaseName' is mandatory.";
            throw new IllegalArgumentException( msg );
        }

        if ( Strings.isNullOrEmpty( projectId ) )
        {
            String msg = "The property 'credential.firebase.projectId' is mandatory.";
            throw new IllegalArgumentException( msg );
        }

        String databaseUrl = "https://" + databaseName + ".firebaseio.com";
        logger.info( "The final Firebase database URL: " + databaseUrl );

        if ( !init.credentialOn )
        {

            options = new FirebaseOptions.Builder()
                    .setCredentials( GoogleCredentials.getApplicationDefault() )
                    .setDatabaseUrl( databaseUrl )
                    .setProjectId( projectId )
                    .build();

            logger.info( "Firebase-admin built with application default credentials." );
        }
        else
        {
            if ( Strings.isNullOrEmpty( init.fileName ) )
            {
                String msg = "The property 'credential.firebase.fileName' for current configuration is mandatory.";
                throw new IllegalArgumentException( msg );
            }

            URL url = GoogleApiFirebaseModule.class.getResource( init.fileName );
            if ( url == null )
            {
                String msg = "The file defined by property 'credential.firebase.fileName' "
                        + init.fileName + " has not been found.";
                throw new IllegalArgumentException( msg );
            }
            FileInputStream serviceAccount = new FileInputStream( url.getPath() );

            options = new FirebaseOptions.Builder()
                    .setCredentials( GoogleCredentials.fromStream( serviceAccount ) )
                    .setDatabaseUrl( databaseUrl )
                    .setProjectId( projectId )
                    .build();

            logger.info( "Firebase-admin built with credentials from file." );
        }

        FirebaseApp.initializeApp( options );

        return new IdentityHandler();
    }

    static class IdentityApiInit
    {
        @Inject( optional = true )
        @Named( "credential.firebase.credentialOn" )
        boolean credentialOn = false;

        @Inject( optional = true )
        @Named( "credential.firebase.fileName" )
        String fileName;

        @Inject( optional = true )
        @Named( "credential.firebase.projectId" )
        String projectId;

        @Inject( optional = true )
        @Named( "credential.firebase.databaseName" )
        String databaseName;
    }
}