Converting string to web-safe Base64 format

Question

I am testing how to update user picture using the Admin SDK Directory Service with Google Apps Scripts with the following function:

function updatePhoto(){
  var fileId = 'XXXXXXXXXXXXXXXXXXX';
  var b = DocsList.getFileById(fileId).getBlob();
  var encoded = Utilities.base64Encode(b.getBytes());

  encoded = encoded.replace(/\//g,'_').replace(/\+/g,'-').replace(/\=/g,'*');
  AdminDirectory.Users.Photos.update({
    "photoData": encoded },'[email protected]');
}

However, it doesn't always work. Whenever there is padding in the base64 encoded string, it fails. Referring to Google's document (https://developers.google.com/admin-sdk/directory/v1/reference/users/photos/update), I am a bit confused with the descriptions. It says:

The equals sign (=) character is replaced with the asterisk (*).
For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing.

What should be actually done? (=) is used for padding in Base64. So, should I use (*) or (.)? I did try to replace (=) with (.) but no luck.

Can anyone help?

It is so strange. It works when i do not replace (=).

function updatePhoto(){
  var fileId = 'XXXXXXXXXXXXXXXXXXX';
  var b = DocsList.getFileById(fileId).getBlob();
  var encoded = Utilities.base64Encode(b.getBytes());

  encoded = encoded.replace(/\//g,'_').replace(/\+/g,'-');
  AdminDirectory.Users.Photos.update({
    "photoData": encoded },'[email protected]');

}

Jay Lee · Accepted Answer · 2014-03-02 18:51:15Z

8

The API requires you to use URL-safe base64 encoding. After doing the base64 encoding, try replacing / with _ and + with -. Details at:

https://developers.google.com/admin-sdk/directory/v1/reference/users/photos/update

answered Mar 2, 2014 at 18:51

Jay Lee

13.5k3 gold badges32 silver badges60 bronze badges

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

5 Comments

user2054013 Over a year ago

Thanks a lot. It works. I got confused by that description and the error message. After adding the following line before the AdminDirectory line, it works. encoded = encoded.replace(/\//g,'_').replace(/\+/g,'-').replace(/\=/g,'*'); "

user2054013 Over a year ago

:) Oh. I just found that it doesn't work for all photos.

user2054013 Over a year ago

I just figured out the problem came from the padding. Whenever there is padding, it fails. I have edited the question accordingly.

user2054013 Over a year ago

This is so funny. I kinda solved that problem by simply leave (=) unchanged. Strange. encoded = encoded.replace(/\//g,'_').replace(/\+/g,'-');

AJ007 Over a year ago

what about the german characters like ä,ü,ö & ß?

Daniel Marín · Accepted Answer · 2014-10-03 07:56:31Z

4

I know that this is quite old, but I'm working in something similar and I want to share my solution. You can use this function to convert your string to a base64safeurl string:

protected static string Base64ForUrlEncode(string str)
        {

            StringBuilder result = new StringBuilder(Convert.ToBase64String(Encoding.ASCII.GetBytes(str)).TrimEnd('='));
            result.Replace('+', '-');
            result.Replace('/', '_');
            return result.ToString();
        }

More info here: http://www.codeproject.com/Tips/76650/Base-base-url-base-url-and-z-base-encoding

Note: This is C# code, so this solution is for .NET developments.

edited Oct 3, 2014 at 7:56

answered Sep 24, 2014 at 14:05

Daniel Marín

1,45716 silver badges39 bronze badges

8 Comments

Serge insas Over a year ago

This only replaces first occurrence,the code in the comments does it globally.

Daniel Marín Over a year ago

Sorry, but I don't understand. Can you explain what do you mean with "first occurrence"?

Serge insas Over a year ago

result.Replace('+', '-'); replaces only first occurrence of +, if you want all the + in a string to be replaced you need to use the g flag like in the answer below (g comes for 'global')

Daniel Marín Over a year ago

.NET documentation says: "Returns a new string in which all occurrences of a specified string in the current instance are replaced with another specified string."

Daniel Marín Over a year ago

I know. My solution is in .NET. Like I said in the answer, I just wanted to share it. Could be useful to someone. I should edit my answer and make clear that is C# code.

|

Good Lux · Accepted Answer · 2015-11-11 16:53:04Z

2

To add to @Jay lee's and @Daniel Marin's answers:

if you are using Python to encode, you can use:

base64.urlsafe

function, and in Java, you can use:

Base64.encodeBase64URLSafeString(byte[] binaryData)

answered Nov 11, 2015 at 16:53

Good Lux

1,00310 silver badges21 bronze badges

Comments

Florian Sesser · Accepted Answer · 2021-05-11 08:44:59Z

1

RFC 4648 specifies "web-safe" base64 and calls it "base64url": https://datatracker.ietf.org/doc/html/rfc4648#section-5

answered May 11, 2021 at 8:44

Florian Sesser

6,1531 gold badge27 silver badges26 bronze badges

Collectives™ on Stack Overflow

Converting string to web-safe Base64 format

4 Answers 4

5 Comments

8 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

5 Comments

8 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related