Decode base64Url in Java

Question

https://web.archive.org/web/20110422225659/https://en.wikipedia.org/wiki/Base64#URL_applications

talks about base64Url - Decode

a modified Base64 for URL variant exists, where no padding '=' will be used, and the '+' and '/' characters of standard Base64 are respectively replaced by '-' and '_'

I created the following function:

public static String base64UrlDecode(String input) {
    String result = null;
    BASE64Decoder decoder = new BASE64Decoder();
    try {
        result = decoder.decodeBuffer(input.replace('-','+').replace('/','_')).toString();
    }
    catch (IOException e) {
        System.out.println(e.getMessage());
    }
    return result;
}

it returns a very small set of characters that don't even resemble to the expected results. any ideas?

You shouldn't use sun.misc.BASE64Decoder because it is internal Sun/Oracle code (not part of J2SE) and may disappear at any time. The class Base64 in Apache Commons should provide you with all the functionality you need. — Benjamin Muschko
– Benjamin Muschko, Commented Apr 12, 2011 at 20:44
my question is how to properly decode a base64url string in java. and thanks i'll try apache commons — ufk
– ufk, Commented Apr 12, 2011 at 20:47
@Benjamin, wow, I didn't realize BASE64Decoder was a Sun class, internal or otherwise. I wonder why they broke with their own naming convention. +1 — Pops
– Pops, Commented Apr 12, 2011 at 20:49
@BenjaminMuschko Might be nice to clarify that is it specifically in Apache Commons Codec for those that don't realise it is a link in your comment! :) — Sled
– Sled, Commented Apr 16, 2014 at 14:21

Boris Treukhov · Accepted Answer · 2016-07-09 22:54:02Z

93

Java8+

import java.util.Base64;


return Base64.getUrlEncoder().encodeToString(bytes);

answered Jul 9, 2016 at 22:54

Boris Treukhov

17.8k9 gold badges73 silver badges93 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Yaroslav Lozynskyi Over a year ago

If you don't like trailing '=' (padding), then use: Base64.getUrlEncoder().withoutPadding().encodeToString(str.g‌etBytes(UTF_8))

Boris Treukhov Over a year ago

@kiedysktos do you have an example sequence? Table The "URL and Filename safe" Base 64 Alphabet in does not allow / in RFC 4648 which getUrlEncoder() uses

kiedysktos Over a year ago

EDIT: OK, I was using getEncoder() instead of getUrlEncoder(), my fault

Community · Accepted Answer · 2021-10-07 07:34:52Z

53

Base64 encoding is part of the JDK since Java 8. URL safe encoding is also supported with java.util.Base64.getUrlEncoder(), and the "=" padding can be skipped by additionally using the java.util.Base64.Encoder.withoutPadding() method:

import java.nio.charset.StandardCharsets;
import java.util.Base64;

public String encode(String raw) {
    return Base64.getUrlEncoder()
            .withoutPadding()
            .encodeToString(raw.getBytes(StandardCharsets.UTF_8));
}

edited Oct 7, 2021 at 7:34

CommunityBot

11 silver badge

answered Mar 27, 2015 at 9:29

deamon

93.1k117 gold badges332 silver badges461 bronze badges

2 Comments

T3rm1 Over a year ago

The resulting string still contains equal signs. That's not URL safe, is it?

Yaroslav Lozynskyi Over a year ago

Use Base64.getUrlEncoder().withoutPadding().encodeToString(str.getBytes(UTF_8))

Paolo Moretti · Accepted Answer · 2012-10-08 08:52:03Z

26

With the usage of Base64 from Apache Commons, who can be configured to URL safe, I created the following function:

import org.apache.commons.codec.binary.Base64;

public static String base64UrlDecode(String input) {
    String result = null;
    Base64 decoder = new Base64(true);
    byte[] decodedBytes = decoder.decode(input);
    result = new String(decodedBytes);
    return result;
}

The constructor Base64(true) makes the decoding URL-safe.

edited Oct 8, 2012 at 8:52

Paolo Moretti

56.5k23 gold badges103 silver badges93 bronze badges

answered Apr 12, 2011 at 21:23

ufk

32.4k75 gold badges258 silver badges422 bronze badges

1 Comment

Mithaldu Over a year ago

idle curiosity, why make it that verbose if you could just do this? return new String(new Base64(true).decode(input));

Oded Breiner · Accepted Answer · 2016-03-05 12:19:28Z

8

In the Android SDK, there's a dedicated flag in the Base64 class: Base64.URL_SAFE, use it like so to decode to a String:

import android.util.Base64;
byte[] byteData = Base64.decode(body, Base64.URL_SAFE);
str = new String(byteData, "UTF-8");

edited Mar 5, 2016 at 12:19

answered Mar 5, 2016 at 11:17

Oded Breiner

29.9k10 gold badges110 silver badges74 bronze badges

Comments

Community · Accepted Answer · 2016-06-22 09:55:47Z

6

Guava now has Base64 decoding built in.

https://google.github.io/guava/releases/17.0/api/docs/com/google/common/io/BaseEncoding.html

edited Jun 22, 2016 at 9:55

CommunityBot

11 silver badge

answered Dec 17, 2012 at 19:10

jontro

10.7k6 gold badges49 silver badges71 bronze badges

Comments

terentev · Accepted Answer · 2012-03-04 22:55:23Z

5

public static byte[] encodeUrlSafe(byte[] data) {
    byte[] encode = Base64.encode(data);
    for (int i = 0; i < encode.length; i++) {
        if (encode[i] == '+') {
            encode[i] = '-';
        } else if (encode[i] == '/') {
            encode[i] = '_';
        }
    }
    return encode;
}

public static byte[] decodeUrlSafe(byte[] data) {
    byte[] encode = Arrays.copyOf(data, data.length);
    for (int i = 0; i < encode.length; i++) {
        if (encode[i] == '-') {
            encode[i] = '+';
        } else if (encode[i] == '_') {
            encode[i] = '/';
        }
    }
    return Base64.decode(encode);
}

answered Mar 4, 2012 at 22:55

terentev

6641 gold badge9 silver badges10 bronze badges

1 Comment

pi. Over a year ago

Warning: Trailing = characters get swallowed!

Pops · Accepted Answer · 2011-04-12 20:39:30Z

3

Right off the bat, it looks like your replace() is backwards; that method replaces the occurrences of the first character with the second, not the other way around.

answered Apr 12, 2011 at 20:39

Pops

31k37 gold badges139 silver badges153 bronze badges

Comments

overthink · Accepted Answer · 2013-11-04 19:41:31Z

2

@ufk's answer works, but you don't actually need to set the urlSafe flag when you're just decoding.

urlSafe is only applied to encode operations. Decoding seamlessly handles both modes.

Also, there are some static helpers to make it shorter and more explicit:

import org.apache.commons.codec.binary.Base64;
import org.apache.commons.codec.binary.StringUtils;

public static String base64UrlDecode(String input) {
  StringUtils.newStringUtf8(Base64.decodeBase64(input));
}

Docs

answered Nov 4, 2013 at 19:41

overthink

24.6k4 gold badges71 silver badges69 bronze badges

Comments

Hadi Note · Accepted Answer · 2019-01-24 17:27:47Z

1

This class can help:

import android.util.Base64;

public class Encryptor {

    public static String encode(String input) {
        return Base64.encodeToString(input.getBytes(), Base64.URL_SAFE);
    }

    public static String decode(String encoded) {
        return new String(Base64.decode(encoded.getBytes(), Base64.URL_SAFE));
    }
}

answered Jan 24, 2019 at 17:27

Hadi Note

1,43518 silver badges17 bronze badges

Comments

Mike Warren · Accepted Answer · 2023-11-07 20:37:01Z

1

I know the answer is already there, but still, if someone wants...

import java.util.Base64; 

public class Base64BasicEncryptionExample {  

    public static void main(String[] args) {  

       // Getting encoder  
       Base64.Encoder encoder = Base64.getUrlEncoder();  
       // Encoding URL  
       String eStr = encoder.encodeToString
                               ("http://www.javatpoint.com/javatutorial/".getBytes());  
       System.out.println("Encoded URL: "+eStr);  

       // Getting decoder  
       Base64.Decoder decoder = Base64.getUrlDecoder();  
       // Decoding URl  
       String dStr = new String(decoder.decode(eStr));  
       System.out.println("Decoded URL: "+dStr);  
    }  
}

Took help from: https://www.javatpoint.com/java-base64-encode-decode

edited Nov 7, 2023 at 20:37

Mike Warren

3,9109 gold badges54 silver badges111 bronze badges

answered Apr 17, 2021 at 2:24

Jay

3482 silver badges11 bronze badges

Comments

Nick Dong · Accepted Answer · 2023-03-22 06:57:52Z

Base64.getUrlEncoder() already using -, _ instead of +, /.

See:

java-1.8.0/src.zip!/java/util/Base64.java

java.util.Base64

    /* Returns a Base64.Encoder that encodes using the URL and Filename safe type 
     * base64 encoding scheme.
     * Returns: A Base64 encoder.
     * */


    public static Encoder getUrlEncoder() {
         return Encoder.RFC4648_URLSAFE;
    }

...

    /*
     * It's the lookup table for "URL and Filename safe Base64" as specified in 
     * Table 2 of the RFC 4648, with the '+' and '/' changed to '-' and '_'. This 
     * table is used when BASE64_URL is specified.
     * */

    private static final char[] toBase64URL = {
        'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
        'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
        'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
        'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
        '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '_'
    };

...

    static final Encoder RFC4648_URLSAFE = new Encoder(true, null, -1, true);

Asokan · Accepted Answer · 2016-01-04 15:28:24Z

-1

In Java try the method Base64.encodeBase64URLSafeString() from Commons Codec library for encoding.

edited Jan 4, 2016 at 15:28

answered Nov 26, 2015 at 14:39

Asokan

1191 silver badge4 bronze badges

Collectives™ on Stack Overflow

Decode base64Url in Java

12 Answers 12

3 Comments

2 Comments

1 Comment

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

12 Answers 12

3 Comments

2 Comments

1 Comment

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related