coreFirebase

Documentation

Overview

Package coreFirebase

This is the STY-Holdings shared services

NOTES:

None

COPYRIGHT & WARRANTY:

Copyright (c) 2022 STY-Holdings, inc
All rights reserved.

This software is the confidential and proprietary information of STY-Holdings, Inc.
Use is subject to license terms.

Unauthorized copying of this file, via any medium is strictly prohibited.

Proprietary and confidential

Written by Scott Yacko / syacko
STY-Holdings, Inc.
support@sty-holdings.com
www.sty-holdings.com

01-2024
USA

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.

Index

• Variables
• func FindFirebaseAuthUser(authPtr *auth.Client, username string) (userRecordPtr *auth.UserRecord, errorInfo pi.ErrorInfo)
• func GetFirebaseAppAuthConnection(credentialsFQN string) (appPtr *firebase.App, authPtr *auth.Client, errorInfo pi.ErrorInfo)
• func GetFirebaseAuthConnection(appPtr *firebase.App) (authPtr *auth.Client, errorInfo pi.ErrorInfo)
• func GetFirebaseIdTokenPayload(authPtr *auth.Client, idToken string) (tokenPayload map[any]interface{}, errorInfo pi.ErrorInfo)
• func GetIdTokenPtr(authPtr *auth.Client, idToken string) (IdTokenPtr *auth.Token, errorInfo pi.ErrorInfo)
• func IsFirebaseIdTokenValid(authPtr *auth.Client, idToken string) bool
• func NewFirebaseApp(credentialsFQN string) (appPtr *firebase.App, errorInfo pi.ErrorInfo)
• func SetFirebaseAuthEmailVerified(authPtr *auth.Client, username string) (errorInfo pi.ErrorInfo)
• func ValidateFirebaseJWTPayload(tokenPayload map[any]interface{}, audience, issuer string) (errorInfo pi.ErrorInfo)

Variables

var (
	CTXBackground = context.Background()
)

Functions

func FindFirebaseAuthUser

func FindFirebaseAuthUser(
	authPtr *auth.Client,
	username string,
) (
	userRecordPtr *auth.UserRecord,
	errorInfo pi.ErrorInfo,
)

FindFirebaseAuthUser - determines if the user exists in the Firebase Auth database. If so, then pointer to the user is return, otherwise, an error.

Customer Messages: None
Errors: None
Verifications: None

func GetFirebaseAppAuthConnection

func GetFirebaseAppAuthConnection(credentialsFQN string) (
	appPtr *firebase.App,
	authPtr *auth.Client,
	errorInfo pi.ErrorInfo,
)

GetFirebaseFirestoreConnection

Customer Messages: None
Errors: None
Verifications: None

func GetFirebaseAuthConnection

func GetFirebaseAuthConnection(appPtr *firebase.App) (
	authPtr *auth.Client,
	errorInfo pi.ErrorInfo,
)

GetFirebaseAuthConnection - creates a new Firebase Auth Connection

Customer Messages: None
Errors: None
Verifications: None

func GetFirebaseIdTokenPayload

func GetFirebaseIdTokenPayload(
	authPtr *auth.Client,
	idToken string,
) (
	tokenPayload map[any]interface{},
	errorInfo pi.ErrorInfo,
)

GetFirebaseIdTokenPayload

func GetIdTokenPtr

func GetIdTokenPtr(
	authPtr *auth.Client,
	idToken string,
) (
	IdTokenPtr *auth.Token,
	errorInfo pi.ErrorInfo,
)

GetIdTokenPtr

func IsFirebaseIdTokenValid

func IsFirebaseIdTokenValid(
	authPtr *auth.Client,
	idToken string,
) bool

IsFirebaseIdTokenValid

func NewFirebaseApp

func NewFirebaseApp(credentialsFQN string) (
	appPtr *firebase.App,
	errorInfo pi.ErrorInfo,
)

NewFirebaseApp - creates a new Firebase App

Customer Messages: None
Errors: None
Verifications: None

func SetFirebaseAuthEmailVerified

func SetFirebaseAuthEmailVerified(
	authPtr *auth.Client,
	username string,
) (errorInfo pi.ErrorInfo)

SetFirebaseAuthEmailVerified - This will set the Firebase Auth email verify flag to true

func ValidateFirebaseJWTPayload

func ValidateFirebaseJWTPayload(
	tokenPayload map[any]interface{},
	audience, issuer string,
) (errorInfo pi.ErrorInfo)

ValidateFirebaseJWTPayload - Firebase ID Token that is returned when a user logs on successfully