com.gigya.socialize

Class SigUtils

java.lang.Object

com.gigya.socialize.SigUtils

public class SigUtils
extends java.lang.Object

This class is a utility class with static methods for calculating and validating cryptographic signatures.

Constructor Summary

Constructors

Constructor and Description
SigUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	calcOAuth1BaseString(java.lang.String httpMethod, java.lang.String url, GSRequest request)
static java.lang.String	getDynamicSessionSignature(java.lang.String glt_cookie, int timeoutInSeconds, java.lang.String secret) This is a utility method for generating the cookie value of a dynamic session expiration cookie.
static java.lang.String	getOAuth1Signature(java.lang.String baseString, java.lang.String secret)
static boolean	validateFriendSignature(java.lang.String UID, java.lang.String timestamp, java.lang.String friendUID, java.lang.String secret, java.lang.String signature) Use this method to verify the authenticity of a socialize.getFriendsInfo API method response, to make sure it is in fact originating from Gigya, and prevent fraud.
static boolean	validateUserSignature(java.lang.String UID, java.lang.String timestamp, java.lang.String secret, java.lang.String signature) Use this method to verify the authenticity of a socialize.getUserInfo API method response, to make sure it is in fact originating from Gigya, and prevent fraud.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SigUtils

public SigUtils()

Method Detail

validateUserSignature

public static boolean validateUserSignature(java.lang.String UID,
                                            java.lang.String timestamp,
                                            java.lang.String secret,
                                            java.lang.String signature)
                                     throws java.security.InvalidKeyException,
                                            java.io.UnsupportedEncodingException

Use this method to verify the authenticity of a socialize.getUserInfo API method response, to make sure it is in fact originating from Gigya, and prevent fraud. The "socialize.getUserInfo" API method response data include the following fields: UID, signatureTimestamp (a timestamp) and UIDSignature (a cryptographic signature). Pass these fields as the corresponding parameters of this method, along with your partner's "Secret Key". Your secret key (provided in BASE64 encoding) is located at the bottom of the Site Setup page on Gigya's website. The return value of the method indicates if the signature is valid (thus, originating from Gigya) or not.

Parameters:

UID - pass the UID field returned by the "socialize.getUserInfo" API method response

timestamp - pass the signatureTimestamp field returned by the "socialize.getUserInfo" API method response

secret - your partner's "Secret Key", obtained from Gigya's website.

signature - pass the UIDSignature field returned by the "socialize.getUserInfo" API method response

Throws:

java.security.InvalidKeyException

java.io.UnsupportedEncodingException

validateFriendSignature

public static boolean validateFriendSignature(java.lang.String UID,
                                              java.lang.String timestamp,
                                              java.lang.String friendUID,
                                              java.lang.String secret,
                                              java.lang.String signature)
                                       throws java.security.InvalidKeyException,
                                              java.io.UnsupportedEncodingException

Use this method to verify the authenticity of a socialize.getFriendsInfo API method response, to make sure it is in fact originating from Gigya, and prevent fraud. The "socialize.getFriendsInfo" API method response data include the following fields: UID, signatureTimestamp (a timestamp) and friendshipSignature (a cryptographic signature). Pass these fields as the corresponding parameters of this method, along with your partner's "Secret Key". Your secret key (provided in BASE64 encoding) is located at the bottom of the Site Setup page on Gigya's website. The return value of the method indicates if the signature is valid (thus, originating from Gigya) or not.

Parameters:

UID - pass the UID field returned by the "socialize.getFriendsInfo" API method response

timestamp - pass the signatureTimestamp field returned by the "socialize.getFriendsInfo" API method response

secret - your partner's "Secret Key", obtained from Gigya's website.

signature - pass the friendshipSignature field returned by the "socialize.getFriendsInfo" API method response

Throws:

java.security.InvalidKeyException

java.io.UnsupportedEncodingException

getOAuth1Signature

public static java.lang.String getOAuth1Signature(java.lang.String baseString,
                                                  java.lang.String secret)
                                           throws java.security.InvalidKeyException,
                                                  java.net.MalformedURLException,
                                                  java.io.UnsupportedEncodingException

Throws:

java.security.InvalidKeyException

java.net.MalformedURLException

java.io.UnsupportedEncodingException

calcOAuth1BaseString

public static java.lang.String calcOAuth1BaseString(java.lang.String httpMethod,
                                                    java.lang.String url,
                                                    GSRequest request)
                                             throws java.net.MalformedURLException,
                                                    java.io.UnsupportedEncodingException

Throws:

java.net.MalformedURLException

java.io.UnsupportedEncodingException

getDynamicSessionSignature

public static java.lang.String getDynamicSessionSignature(java.lang.String glt_cookie,
                                                          int timeoutInSeconds,
                                                          java.lang.String secret)
                                                   throws java.security.InvalidKeyException,
                                                          java.io.UnsupportedEncodingException

This is a utility method for generating the cookie value of a dynamic session expiration cookie. Use this method as part of implementing dynamic control over login session expiration, in conjunction with assigning the value '-1' to the sessionExpiration parameter of the client side login methods (i.e. showLoginUI / login). Learn more in the Control Session Expiration guide.

Parameters:

glt_cookie - the login token received from Gigya after successful Login. Gigya stores the token in a cookie named: "glt_" + [Your API Key]

timeoutInSeconds - how many seconds until session expiration. For example, if you would like the session to expire in 5 minutes set this parameter to 300.

secret - your Gigya "Secret Key", is provided, in BASE64 encoding, at the bottom of the Dashboard page on the Gigya's website.

Throws:

java.security.InvalidKeyException

java.io.UnsupportedEncodingException