gojwtcognito

gojwtcognito is an easy to use, small package designed to parse request headers and look for JWTs provided by AWS Cognito to either check if they are valid or get info from them.

Install

$ go get github.com/bruno-chavez/gojwtcognito

Usage

Import the package, call a NewCognitoChecker. From here you pass the object pointer to where you need to validate tokens, get claims or groups.

Usage Tips

• You can then pass the CognitoChecker object pointer to other parts of your code that get called multiple times, like server handlers for example.

• The region, User Pool ID and App Client can all be found inside AWS Cognito.

• The supported tokens that Cognito uses for authentication are either accessToken or idToken.

• If you need to check for user data like emails, names or associated groups idToken is what you are looking for.

• The claims inside each JWT varies depends on the token type you pass to GetClaims.

Documentation

Check the GoDoc page for more info on what is available inside the package.

Examples

Generating the object

cognitoChecker := gojwtcognito.NewCognitoChecker(
                       "us-east-1",
                       "us-east-1_apwePSzx",
                       "3b1fh12qzvmgjuio563qtm678u",
                  )

Validating an accessToken

func verifyUser(w http.ResponseWriter, r *http.Request, c *cognitoChecker) {

    err := c.ValidateTokenFromHeader(r, "accessToken")
    if err != nil {
        log.Println(err)
        return
    }
    
    err = c.ValidateTokenFromHeader(r, "idToken")
    if err != nil {
        log.Println(err)
        return
    }

}

Looking up a specific claim

claims is a map of type map[string]interface{}

func Claims(w http.ResponseWriter, r *http.Request, c *cognitoChecker) {

    claims, err := c.GetClaims(r, "idToken")
    if err != nil {
        log.Println(err)
    }
    
    log.Println(claims["cognito:username"])
}

Looking up all the groups of a user

groups is a slice of type []string

func Groups(w http.ResponseWriter, r *http.Request, c *cognitoChecker) {

    groups, err := c.GetGroups(r)
    if err != nil {
        log.Println(err)
    }
    
    for _, v := range groups {
        fmt.Println(v)
    }
}

Contribute

Found a bug or an error? Post it in the issue tracker.

Want to add an awesome new feature? Fork this repository and add your feature, then send a pull request.

License

The MIT License (MIT) Copyright (c) 2020 Bruno Chavez