Код для декодирования / кодирования измененного URL-адреса base64

113

Я хочу кодировать данные base64, чтобы поместить их в URL-адрес, а затем декодировать их в моем HttpHandler.

Я обнаружил, что кодировка Base64 позволяет использовать символ '/', который испортит мое сопоставление UriTemplate. Затем я обнаружил, что есть концепция «модифицированного Base64 для URL» из Википедии:

Существует модифицированный вариант Base64 для URL-адреса, в котором не будет использоваться заполнение '=', а символы '+' и '/' стандартного Base64 заменены соответственно на '-' и '_', чтобы использовать кодировщики / декодеры URL больше не требуется и не влияет на длину закодированного значения, оставляя ту же закодированную форму нетронутой для использования в реляционных базах данных, веб-формах и идентификаторах объектов в целом.

Используя .NET, я хочу изменить свой текущий код, заменив базовое кодирование и декодирование base64 на использование метода «измененный base64 для URL». Кто-нибудь это делал?

Я знаю, что декодирование начинается с чего-то вроде:

string base64EncodedText = base64UrlEncodedText.Replace('-', '+').Replace('_', '/');

// Append '=' char(s) if necessary - how best to do this?

// My normal base64 decoding now uses encodedText

Но мне потенциально нужно добавить один или два символа '=' в конец, что выглядит немного сложнее.

Моя логика кодирования должна быть немного проще:

// Perform normal base64 encoding
byte[] encodedBytes = Encoding.UTF8.GetBytes(unencodedText);
string base64EncodedText = Convert.ToBase64String(encodedBytes);

// Apply URL variant
string base64UrlEncodedText = base64EncodedText.Replace("=", String.Empty).Replace('+', '-').Replace('/', '_');

Я видел Guid to Base64 для записи URL StackOverflow, но она имеет известную длину, и поэтому они могут жестко закодировать количество знаков равенства, необходимых в конце.

Кирк Лиемон
источник
@ Кирк: Подправьте мой ответ проверенной математикой.
AnthonyWJones,

Ответы:

69

Это должно правильно заполнить его: -

 base64 = base64.PadRight(base64.Length + (4 - base64.Length % 4) % 4, '=');
AnthonyWJones
источник
11
Ба, ты победил меня. Я просто удалю свой пост, потому что похоже, что я скопировал вас :)
AaronLS
3
Разве это не добавит до трех символов "="? Похоже, их будет только 0, 1 или 2.
Кирк Лимон, 04
1
@Kirk: Если он добавляет 3 символа, то строка base64 уже повреждена. Думаю, было бы неплохо проверить строку, она должна содержать только ожидаемые символы и
длину
Хммм. Попытка этого не сработает. Все еще ищу ответы. Количество знаков равенства просто не совпадает с правильным.
Кирк Лимон,
2
@AnthonyWJones 'он должен содержать только ожидаемые символы и длину% 4! = 1 ', верно?
blueling
173

Также проверьте класс HttpServerUtility с методами UrlTokenEncode и UrlTokenDecode, которые обрабатывают безопасное для URL-адресов кодирование и декодирование Base64.

Примечание 1. Результат не является допустимой строкой Base64. Некоторые небезопасные символы URL заменены.

Примечание 2: результат отличается от алгоритма base64url в RFC4648.

///<summary>
/// Base 64 Encoding with URL and Filename Safe Alphabet using UTF-8 character set.
///</summary>
///<param name="str">The origianl string</param>
///<returns>The Base64 encoded string</returns>
public static string Base64ForUrlEncode(string str)
{
    byte[] encbuff = Encoding.UTF8.GetBytes(str);
    return HttpServerUtility.UrlTokenEncode(encbuff);
}
///<summary>
/// Decode Base64 encoded string with URL and Filename Safe Alphabet using UTF-8.
///</summary>
///<param name="str">Base64 code</param>
///<returns>The decoded string.</returns>
public static string Base64ForUrlDecode(string str)
{
    byte[] decbuff = HttpServerUtility.UrlTokenDecode(str);
    return Encoding.UTF8.GetString(decbuff);
}
Фредрик Хаглунд
источник
Спасибо за чаевые. Я попробую в следующий раз!
Kirk Liemohn
12
Ваш совет был великолепным завершением многочасового поиска ответа. спасибо
Praesagus
Разве это не будет использовать кодировку% для каждого / + и =? Это не так эффективно, как другой ответ
JoelFan 01
Нет, он заменяет знаки равенства, используемые для заполнения в конце, числом, а плюс и косую черту заменяет минусом и подчеркиванием.
Fredrik Haglund
15
Обратите внимание, что UrlTokenEncodeэто не совсем base64url , поскольку он заменяет заполнение '=' на '0', '1' или '2' в зависимости от того, сколько знаков равенства он заменил.
ladenedge
28

Недостаточно точек для комментариев, но в случае, если это помогает, фрагмент кода, который Сушил нашел в предоставленной ссылке (проект ietf веб-подписи JSON), работает при кодировании Base 64 в качестве параметра в URL-адресе.

Скопированный фрагмент ниже для ленивых:

    static string Base64UrlEncode(byte[] arg)
    {
        string s = Convert.ToBase64String(arg); // Regular base64 encoder
        s = s.Split('=')[0]; // Remove any trailing '='s
        s = s.Replace('+', '-'); // 62nd char of encoding
        s = s.Replace('/', '_'); // 63rd char of encoding
        return s;
    }

    static byte[] Base64UrlDecode(string arg)
    {
        string s = arg;
        s = s.Replace('-', '+'); // 62nd char of encoding
        s = s.Replace('_', '/'); // 63rd char of encoding
        switch (s.Length % 4) // Pad with trailing '='s
        {
            case 0: break; // No pad chars in this case
            case 2: s += "=="; break; // Two pad chars
            case 3: s += "="; break; // One pad char
            default: throw new System.Exception(
              "Illegal base64url string!");
        }
        return Convert.FromBase64String(s); // Standard base64 decoder
    }
Стефан Звонар
источник
это совместимо с Xamarin, чтобы не использовать System.Web
Реза Мортазави,
Именно то, что я искал! Действительно хороший вариант для Xamarin без необходимости извлекать библиотеку.
Sleeping_Giant
19

Я попал сюда, ища код для кодирования / декодирования для кодировки base64url, которая мало отличается от base64, как описано в вопросе.

В этом документе обнаружен фрагмент кода C #. Проект ietf веб-подписи JSON

Sushil
источник
2
Это было единственное решение, которое сработало для меня при разборе сообщения в GMail API v1 (Message.Raw)
HeyZiko
5

По сравнению с принятым ответом, вот как вы бы в основном декодировали URL-адрес в кодировке base64, используя C #:

Расшифровать:

string codedValue = "base64encodedUrlHere";

string decoded;
byte[] buffer =  Convert.FromBase64String(codedValue);
decoded = Encoding.UTF8.GetString(buffer);
Крис Хэлкроу
источник
возможно, если вы предоставите более подробную информацию и сравните с принятым ответом, вы сможете получить положительный голос - спасибо
Маурисио Грасиа Гутьеррес