diff --git a/.github/scripts/sync-keycloak-sources.sh b/.github/scripts/sync-keycloak-sources.sh
index 14b3b31..934a722 100755
--- a/.github/scripts/sync-keycloak-sources.sh
+++ b/.github/scripts/sync-keycloak-sources.sh
@@ -40,5 +40,6 @@ if [[ ! $PWD == *keycloak-client ]]; then
error "The script is supposed to be executed in the root of 'keycloak-client' repository";
fi;
+syncFiles client-common-synced
syncFiles admin-client
syncFiles authz-client
diff --git a/README.md b/README.md
index 773d0fe..a2e1fdb 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,16 @@ Keycloak-client java modules
The files in the modules:
+* [client-common-synced](client-common-synced)
* [admin-client](admin-client)
* [authz-client](authz-client)
are not "owned" by this repository and hence the Java files should ideally not be directly updated. Those files are "owned" by the [main Keycloak server repository](https://github.com/keycloak/keycloak)
and hence are supposed to be updated there (whenever needed) and synced into this repository by the bash script [sync-keycloak-sources.sh](.github/scripts/sync-keycloak-sources.sh)
+> [!NOTE]
+> **client-common-synced** module will be synced from Keycloak Main repository for the future and is a dependency of rest of the modules in this repository. Modules **admin-client** and **authz-client** may move to this repository in the future, therefore they are separated.
+
## Syncing the files from Keycloak repository
* Checkout [main Keycloak server repository](https://github.com/keycloak/keycloak) and build it on your laptop to make sure latest Keycloak stuff available in your local maven repository.
diff --git a/admin-client/pom.xml b/admin-client/pom.xml
index 2a90bdd..d3517e7 100755
--- a/admin-client/pom.xml
+++ b/admin-client/pom.xml
@@ -32,6 +32,10 @@
+
+ org.keycloak
+ keycloak-client-common-synced
+ com.fasterxml.jackson.corejackson-core
@@ -99,73 +103,10 @@
sourcestrue${project.build.directory}/unpacked
- **/*
- META-INF/**/*
-
-
- org.keycloak
- keycloak-core
- ${keycloak.version}
- jar
- sources
- true
- ${project.build.directory}/unpacked
-
- org/keycloak/OAuth2Constants.java,
- org/keycloak/TokenCategory.java,
- org/keycloak/Token.java,
- org/keycloak/TokenIdGenerator.java,
- org/keycloak/crypto/KeyUse.java,
- org/keycloak/crypto/Algorithm.java,
- org/keycloak/json/*.java,
- org/keycloak/representations/adapters/action/GlobalRequestResult.java,
- org/keycloak/representations/idm/**/*.java,
- org/keycloak/representations/info/*.java,
- org/keycloak/representations/userprofile/config/*.java,
- org/keycloak/representations/AccessToken.java,
- org/keycloak/representations/AccessTokenResponse.java,
- org/keycloak/representations/AddressClaimSet.java,
- org/keycloak/representations/IDToken.java,
- org/keycloak/representations/JsonWebToken.java,
- org/keycloak/representations/KeyStoreConfig.java,
- org/keycloak/util/BasicAuthHelper.java,
- org/keycloak/util/EnumWithStableIndex.java,
- org/keycloak/util/JsonSerialization.java,
- org/keycloak/util/SystemPropertiesJsonParserFactory.java,
-
-
-
- org.keycloak
- keycloak-common
- ${keycloak.version}
- jar
- sources
- true
- ${project.build.directory}/unpacked
-
- org/keycloak/common/util/Base64.java,
- org/keycloak/common/util/CollectionUtil.java,
- org/keycloak/common/util/MultivaluedHashMap.java,
- org/keycloak/common/util/MultivaluedMap.java,
- org/keycloak/common/util/ObjectUtil.java,
- org/keycloak/common/util/StringPropertyReplacer.java,
- org/keycloak/common/util/SystemEnvProperties.java,
- org/keycloak/common/util/Time.java,
- org/keycloak/common/crypto/CryptoConstants.java,
- org/keycloak/common/constants/ServiceAccountConstants.java,
-
-
-
- org.keycloak
- keycloak-server-spi
- ${keycloak.version}
- jar
- sources
- true
- ${project.build.directory}/unpacked
- org/keycloak/utils/StringUtil.java,
-
+ org/**/*,
+ META-INF/services/*
+
false
diff --git a/admin-client/src/main/java/org/keycloak/admin/client/resource/ClientTypesResource.java b/admin-client/src/main/java/org/keycloak/admin/client/resource/ClientTypesResource.java
index 4138c58..f7f66e2 100644
--- a/admin-client/src/main/java/org/keycloak/admin/client/resource/ClientTypesResource.java
+++ b/admin-client/src/main/java/org/keycloak/admin/client/resource/ClientTypesResource.java
@@ -23,8 +23,6 @@
import jakarta.ws.rs.PUT;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
-
-import org.jboss.resteasy.annotations.cache.NoCache;
import org.keycloak.representations.idm.ClientTypesRepresentation;
/**
@@ -33,7 +31,6 @@
public interface ClientTypesResource {
@GET
- @NoCache
@Produces(MediaType.APPLICATION_JSON)
ClientTypesRepresentation getClientTypes();
diff --git a/authz-client/pom.xml b/authz-client/pom.xml
index ac336f8..c38c107 100644
--- a/authz-client/pom.xml
+++ b/authz-client/pom.xml
@@ -17,12 +17,11 @@
Keycloak Authz: Client APIKeyCloak AuthZ: Client API
-
-
- 11
-
-
+
+ org.keycloak
+ keycloak-client-common-synced
+ org.jboss.loggingjboss-logging
@@ -100,93 +99,10 @@
sourcestrue${project.build.directory}/unpacked
- **/*
- META-INF/**/*
-
-
- org.keycloak
- keycloak-core
- ${keycloak.version}
- jar
- sources
- true
- ${project.build.directory}/unpacked
-
- org/keycloak/OAuth2Constants.java,
- org/keycloak/TokenCategory.java,
- org/keycloak/Token.java,
- org/keycloak/TokenIdGenerator.java,
- org/keycloak/crypto/KeyUse.java,
- org/keycloak/json/*.java,
- org/keycloak/representations/adapters/action/GlobalRequestResult.java,
- org/keycloak/representations/idm/**/*.java,
- org/keycloak/representations/info/*.java,
- org/keycloak/representations/userprofile/config/*.java,
- org/keycloak/representations/AccessToken.java,
- org/keycloak/representations/AccessTokenResponse.java,
- org/keycloak/representations/AddressClaimSet.java,
- org/keycloak/representations/IDToken.java,
- org/keycloak/representations/JsonWebToken.java,
- org/keycloak/representations/KeyStoreConfig.java,
- org/keycloak/util/BasicAuthHelper.java,
- org/keycloak/util/EnumWithStableIndex.java,
- org/keycloak/util/JsonSerialization.java,
- org/keycloak/util/SystemPropertiesJsonParserFactory.java,
-
- org/keycloak/jose/JOSE.java,
- org/keycloak/jose/JOSEHeader.java,
- org/keycloak/jose/jwe/**/*.java,
- org/keycloak/jose/jws/**/*.java,
- org/keycloak/jose/jwk/**/*.java,
- org/keycloak/crypto/**/*.java,
-
- org/keycloak/representations/adapters/config/*.java,
- org/keycloak/representations/RefreshToken.java,
- org/keycloak/protocol/oidc/client/authentication/*.java,
- org/keycloak/util/TokenUtil.java,
- org/keycloak/AuthorizationContext.java,
- org/keycloak/constants/ServiceUrlConstants.java,
-
-
-
-
- org.keycloak
- keycloak-core
- ${keycloak.version}
- jar
- sources
- true
- ${project.build.directory}/unpacked-resources
-
- META-INF/services/**/*
-
-
-
- org.keycloak
- keycloak-common
- ${keycloak.version}
- jar
- sources
- true
- ${project.build.directory}/unpacked
- org/keycloak/common/**/*.java,
-
- org/keycloak/common/util/Base64.java,
- org/keycloak/common/util/CollectionUtil.java,
- org/keycloak/common/util/MultivaluedHashMap.java,
- org/keycloak/common/util/MultivaluedMap.java,
- org/keycloak/common/util/ObjectUtil.java,
- org/keycloak/common/util/StringPropertyReplacer.java,
- org/keycloak/common/util/SystemEnvProperties.java,
- org/keycloak/common/util/Time.java,
-
- org/keycloak/common/util/Encode.java,
- org/keycloak/common/util/Base64Url.java,
- org/keycloak/common/util/PemUtils.java,
- org/keycloak/common/util/MimeTypeUtil.java,
-
-
+ org/**/*,
+ META-INF/services/*
+
false
diff --git a/authz-client/src/main/java/org/keycloak/OAuth2Constants.java b/authz-client/src/main/java/org/keycloak/OAuth2Constants.java
deleted file mode 100755
index b03dd25..0000000
--- a/authz-client/src/main/java/org/keycloak/OAuth2Constants.java
+++ /dev/null
@@ -1,159 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak;
-
-/**
- * @author Stian Thorgersen
- */
-public interface OAuth2Constants {
-
- String CODE = "code";
-
- String TOKEN = "token";
-
- String CLIENT_ID = "client_id";
-
- String CLIENT_SECRET = "client_secret";
-
- String ERROR = "error";
-
- String ERROR_DESCRIPTION = "error_description";
-
- String REDIRECT_URI = "redirect_uri";
-
- String POST_LOGOUT_REDIRECT_URI = "post_logout_redirect_uri";
-
- String ID_TOKEN_HINT = "id_token_hint";
-
- String DISPLAY = "display";
-
- String SCOPE = "scope";
-
- String STATE = "state";
-
- String GRANT_TYPE = "grant_type";
-
- String RESPONSE_TYPE = "response_type";
-
- String ACCESS_TOKEN = "access_token";
-
- String TOKEN_TYPE = "token_type";
-
- String EXPIRES_IN = "expires_in";
-
- String ID_TOKEN = "id_token";
-
- String REFRESH_TOKEN = "refresh_token";
-
- String LOGOUT_TOKEN = "logout_token";
-
- String AUTHORIZATION_CODE = "authorization_code";
-
-
- String IMPLICIT = "implicit";
-
- String USERNAME="username";
-
- String PASSWORD = "password";
-
- String CLIENT_CREDENTIALS = "client_credentials";
-
- // https://tools.ietf.org/html/draft-ietf-oauth-assertions-01#page-5
- String CLIENT_ASSERTION_TYPE = "client_assertion_type";
- String CLIENT_ASSERTION = "client_assertion";
-
- // https://tools.ietf.org/html/draft-jones-oauth-jwt-bearer-03#section-2.2
- String CLIENT_ASSERTION_TYPE_JWT = "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
-
- // http://openid.net/specs/openid-connect-core-1_0.html#OfflineAccess
- String OFFLINE_ACCESS = "offline_access";
-
- // http://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
- String SCOPE_OPENID = "openid";
-
- // http://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims
- String SCOPE_PROFILE = "profile";
- String SCOPE_EMAIL = "email";
- String SCOPE_ADDRESS = "address";
- String SCOPE_PHONE = "phone";
-
- String ORGANIZATION = "organization";
-
- String UI_LOCALES_PARAM = "ui_locales";
-
- String PROMPT = "prompt";
- String ACR_VALUES = "acr_values";
-
- String MAX_AGE = "max_age";
-
- // OIDC Session Management
- String SESSION_STATE = "session_state";
-
- String JWT = "JWT";
-
- // https://tools.ietf.org/html/rfc7636#section-6.1
- String CODE_VERIFIER = "code_verifier";
- String CODE_CHALLENGE = "code_challenge";
- String CODE_CHALLENGE_METHOD = "code_challenge_method";
-
- // https://tools.ietf.org/html/rfc7636#section-6.2.2
- String PKCE_METHOD_PLAIN = "plain";
- String PKCE_METHOD_S256 = "S256";
-
- // https://tools.ietf.org/html/rfc8693#section-2.1
- String TOKEN_EXCHANGE_GRANT_TYPE="urn:ietf:params:oauth:grant-type:token-exchange";
- String AUDIENCE="audience";
- String RESOURCE="resource";
- String REQUESTED_SUBJECT="requested_subject";
- String SUBJECT_TOKEN="subject_token";
- String SUBJECT_TOKEN_TYPE="subject_token_type";
- String ACTOR_TOKEN="actor_token";
- String ACTOR_TOKEN_TYPE="actor_token_type";
- String REQUESTED_TOKEN_TYPE="requested_token_type";
- String ISSUED_TOKEN_TYPE="issued_token_type";
- String REQUESTED_ISSUER="requested_issuer";
- String SUBJECT_ISSUER="subject_issuer";
- String ACCESS_TOKEN_TYPE="urn:ietf:params:oauth:token-type:access_token";
- String REFRESH_TOKEN_TYPE="urn:ietf:params:oauth:token-type:refresh_token";
- String JWT_TOKEN_TYPE="urn:ietf:params:oauth:token-type:jwt";
- String ID_TOKEN_TYPE="urn:ietf:params:oauth:token-type:id_token";
- String SAML2_TOKEN_TYPE = "urn:ietf:params:oauth:token-type:saml2";
-
- String UMA_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:uma-ticket";
-
- // https://tools.ietf.org/html/draft-ietf-oauth-device-flow-15#section-3.4
- String DEVICE_CODE_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:device_code";
- String DEVICE_CODE = "device_code";
-
- String CIBA_GRANT_TYPE = "urn:openid:params:grant-type:ciba";
-
- String INTERVAL = "interval";
- String USER_CODE = "user_code";
-
- // https://openid.net/specs/openid-financial-api-jarm-ID1.html
- String RESPONSE = "response";
-
- // https://www.rfc-editor.org/rfc/rfc9207.html
- String ISSUER = "iss";
-
- String AUTHENTICATOR_METHOD_REFERENCE = "amr";
-
- String CNF = "cnf";
-}
-
-
diff --git a/authz-client/src/main/java/org/keycloak/Token.java b/authz-client/src/main/java/org/keycloak/Token.java
deleted file mode 100644
index e856e2c..0000000
--- a/authz-client/src/main/java/org/keycloak/Token.java
+++ /dev/null
@@ -1,26 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.keycloak;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-
-public interface Token {
-
- @JsonIgnore
- TokenCategory getCategory();
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/TokenCategory.java b/authz-client/src/main/java/org/keycloak/TokenCategory.java
deleted file mode 100644
index 45ab4b0..0000000
--- a/authz-client/src/main/java/org/keycloak/TokenCategory.java
+++ /dev/null
@@ -1,27 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.keycloak;
-
-public enum TokenCategory {
- INTERNAL,
- ACCESS,
- ID,
- ADMIN,
- USERINFO,
- LOGOUT,
- AUTHORIZATION_RESPONSE
-}
diff --git a/authz-client/src/main/java/org/keycloak/TokenIdGenerator.java b/authz-client/src/main/java/org/keycloak/TokenIdGenerator.java
deleted file mode 100755
index fa08536..0000000
--- a/authz-client/src/main/java/org/keycloak/TokenIdGenerator.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak;
-
-import java.util.UUID;
-import java.util.concurrent.atomic.AtomicLong;
-
-/**
- * @author Bill Burke
- * @version $Revision: 1 $
- */
-public class TokenIdGenerator {
- private static final AtomicLong counter = new AtomicLong();
-
- public static String generateId() {
- return UUID.randomUUID().toString() + "-" + System.currentTimeMillis();
- }
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/Version.java b/authz-client/src/main/java/org/keycloak/common/Version.java
deleted file mode 100755
index 21280bb..0000000
--- a/authz-client/src/main/java/org/keycloak/common/Version.java
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Properties;
-
-/**
- * @author Bill Burke
- * @version $Revision: 1 $
- */
-public class Version {
- public static final String UNKNOWN = "UNKNOWN";
- public static final String NAME = "Keycloak";
- public static final String NAME_HTML = "
Keycloak
";
- public static String VERSION;
- public static String RESOURCES_VERSION;
- public static String BUILD_TIME;
-
- static {
- try (InputStream is = Version.class.getResourceAsStream("/keycloak-version.properties")) {
- Properties props = new Properties();
- props.load(is);
- Version.VERSION = props.getProperty("version");
- Version.BUILD_TIME = props.getProperty("build-time");
- Version.RESOURCES_VERSION = Version.VERSION.toLowerCase();
-
- if (Version.RESOURCES_VERSION.endsWith("-snapshot")) {
- Version.RESOURCES_VERSION = Version.RESOURCES_VERSION.replace("-snapshot", "-" + Version.BUILD_TIME.replace(" ", "").replace(":", "").replace("-", ""));
- }
- } catch (IOException e) {
- Version.VERSION = Version.UNKNOWN;
- Version.BUILD_TIME = Version.UNKNOWN;
- }
- }
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/constants/ServiceAccountConstants.java b/authz-client/src/main/java/org/keycloak/common/constants/ServiceAccountConstants.java
deleted file mode 100644
index 4dc0dd1..0000000
--- a/authz-client/src/main/java/org/keycloak/common/constants/ServiceAccountConstants.java
+++ /dev/null
@@ -1,38 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.constants;
-
-/**
- * @author Marek Posolda
- */
-public interface ServiceAccountConstants {
-
- String CLIENT_AUTH = "client_auth";
-
- String SERVICE_ACCOUNT_USER_PREFIX = "service-account-";
-
- String CLIENT_ID_PROTOCOL_MAPPER = "Client ID";
- String CLIENT_HOST_PROTOCOL_MAPPER = "Client Host";
- String CLIENT_ADDRESS_PROTOCOL_MAPPER = "Client IP Address";
-
- String CLIENT_ID_SESSION_NOTE = "clientId";
- String CLIENT_ID = "client_id";
- String CLIENT_HOST = "clientHost";
- String CLIENT_ADDRESS = "clientAddress";
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/crypto/CryptoConstants.java b/authz-client/src/main/java/org/keycloak/common/crypto/CryptoConstants.java
deleted file mode 100644
index 1c53e61..0000000
--- a/authz-client/src/main/java/org/keycloak/common/crypto/CryptoConstants.java
+++ /dev/null
@@ -1,27 +0,0 @@
-package org.keycloak.common.crypto;
-
-/**
- * @author Marek Posolda
- */
-public class CryptoConstants {
-
- // JWE algorithms
- public static final String A128KW = "A128KW";
- public static final String RSA1_5 = "RSA1_5";
- public static final String RSA_OAEP = "RSA-OAEP";
- public static final String RSA_OAEP_256 = "RSA-OAEP-256";
- public static final String ECDH_ES = "ECDH-ES";
- public static final String ECDH_ES_A128KW = "ECDH-ES+A128KW";
- public static final String ECDH_ES_A192KW = "ECDH-ES+A192KW";
- public static final String ECDH_ES_A256KW = "ECDH-ES+A256KW";
-
- // Constant for the OCSP provider
- // public static final String OCSP = "OCSP";
-
- /** Name of Java security provider used with non-fips BouncyCastle. Should be used in non-FIPS environment */
- public static final String BC_PROVIDER_ID = "BC";
-
- /** Name of Java security provider used with fips BouncyCastle. Should be used in FIPS environment */
- public static final String BCFIPS_PROVIDER_ID = "BCFIPS";
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/Base64.java b/authz-client/src/main/java/org/keycloak/common/util/Base64.java
deleted file mode 100644
index ddd7cc9..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/Base64.java
+++ /dev/null
@@ -1,1732 +0,0 @@
-package org.keycloak.common.util;
-
-import java.io.IOException;
-
-/**
- *
The options parameter, which appears in a few places, is used to pass
- * several pieces of information to the encoder. In the "higher level" methods such as
- * encodeBytes( bytes, options ) the options parameter can be used to indicate such
- * things as first gzipping the bytes before encoding them, not inserting linefeeds,
- * and encoding using the URL-safe and Ordered dialects.
- *
- *
Note, according to RFC3548,
- * Section 2.1, implementations should not add line feeds unless explicitly told
- * to do so. I've got Base64 set to this behavior now, although earlier versions
- * broke lines by default.
- *
- *
The constants defined in Base64 can be OR-ed together to combine options, so you
- * might make a call like this:
v2.3.8 - Fixed automatic gzip decoding, based on the content,
- * as this may lead to unexpected behaviour. Request either gzipped
- * or non gzipped decoding as excepted. Automatic encoding is especially
- * problematic with generated input (see KEYCLOAK-18914 for a detailed case).
- *
v2.3.7 - Fixed subtle bug when base 64 input stream contained the
- * value 01111111, which is an invalid base 64 character but should not
- * throw an ArrayIndexOutOfBoundsException either. Led to discovery of
- * mishandling (or potential for better handling) of other bad input
- * characters. You should now get an IOException if you try decoding
- * something that has bad characters in it.
- *
v2.3.6 - Fixed bug when breaking lines and the final byte of the encoded
- * string ended in the last column; the buffer was not properly shrunk and
- * contained an extra (null) byte that made it into the string.
- *
v2.3.5 - Fixed bug in {@link #encodeFromFile} where estimated buffer size
- * was wrong for files of size 31, 34, and 37 bytes.
- *
v2.3.4 - Fixed bug when working with gzipped streams whereby flushing
- * the Base64.OutputStream closed the Base64 encoding (by padding with equals
- * signs) too soon. Also added an option to suppress the automatic decoding
- * of gzipped streams. Also added experimental support for specifying a
- * class loader when using the
- * {@link #decodeToObject(java.lang.String, int, java.lang.ClassLoader)}
- * method.
- *
v2.3.3 - Changed default char encoding to US-ASCII which reduces the internal Java
- * footprint with its CharEncoders and so forth. Fixed some javadocs that were
- * inconsistent. Removed imports and specified things like java.io.IOException
- * explicitly inline.
- *
v2.3.2 - Reduced memory footprint! Finally refined the "guessing" of how big the
- * final encoded data will be so that the code doesn't have to create two output
- * arrays: an oversized initial one and then a final, exact-sized one. Big win
- * when using the {@link #encodeBytesToBytes(byte[])} family of methods (and not
- * using the gzip options which uses a different mechanism with streams and stuff).
- *
v2.3.1 - Added {@link #encodeBytesToBytes(byte[], int, int, int)} and some
- * similar helper methods to be more efficient with memory by not returning a
- * String but just a byte array.
- *
v2.3 - This is not a drop-in replacement! This is two years of comments
- * and bug fixes queued up and finally executed. Thanks to everyone who sent
- * me stuff, and I'm sorry I wasn't able to distribute your fixes to everyone else.
- * Much bad coding was cleaned up including throwing exceptions where necessary
- * instead of returning null values or something similar. Here are some changes
- * that may affect you:
- *
- *
Does not break lines, by default. This is to keep in compliance with
- * RFC3548.
- *
Throws exceptions instead of returning null values. Because some operations
- * (especially those that may permit the GZIP option) use IO streams, there
- * is a possibility of an java.io.IOException being thrown. After some discussion and
- * thought, I've changed the behavior of the methods to throw java.io.IOExceptions
- * rather than return null if ever there's an error. I think this is more
- * appropriate, though it will require some changes to your code. Sorry,
- * it should have been done this way to begin with.
- *
Removed all references to System.out, System.err, and the like.
- * Shame on me. All I can say is sorry they were ever there.
- *
Throws NullPointerExceptions and IllegalArgumentExceptions as needed
- * such as when passed arrays are null or offsets are invalid.
- *
Cleaned up as much javadoc as I could to avoid any javadoc warnings.
- * This was especially annoying before for people who were thorough in their
- * own projects and then had gobs of javadoc warnings on this file.
- *
- *
v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug
- * when using very small files (~< 40 bytes).
- *
v2.2 - Added some helper methods for encoding/decoding directly from
- * one file to the next. Also added a main() method to support command line
- * encoding/decoding from one file to the next. Also added these Base64 dialects:
- *
- *
The default is RFC3548 format.
- *
Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates
- * URL and file name friendly format as described in Section 4 of RFC3548.
- * http://www.faqs.org/rfcs/rfc3548.html
- *
Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates
- * URL and file name friendly format that preserves lexical ordering as described
- * in http://www.faqs.org/qa/rfcc-1940.html
- *
- * Special thanks to Jim Kellerman at http://www.powerset.com/
- * for contributing the new Base64 dialects.
- *
- *
- *
v2.1 - Cleaned up javadoc comments and unused variables and methods. Added
- * some convenience methods for reading and writing to and from files.
- *
v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems
- * with other encodings (like EBCDIC).
- *
v2.0.1 - Fixed an error when decoding a single byte, that is, when the
- * encoded data was a single byte.
- *
v2.0 - I got rid of methods that used booleans to set options.
- * Now everything is more consolidated and cleaner. The code now detects
- * when data that's being decoded is gzip-compressed and will decompress it
- * automatically. Generally things are cleaner. You'll probably have to
- * change some method calls that you were making to support the new
- * options format (ints that you "OR" together).
- *
v1.5.1 - Fixed bug when decompressing and decoding to a
- * byte[] using decode( String s, boolean gzipCompressed ).
- * Added the ability to "suspend" encoding in the Output Stream so
- * you can turn on and off the encoding if you need to embed base64
- * data in an otherwise "normal" stream (like an XML file).
- *
v1.5 - Output stream pases on flush() command but doesn't do anything itself.
- * This helps when using GZIP streams.
- * Added the ability to GZip-compress objects before encoding them.
- *
v1.4 - Added helper methods to read/write files.
- *
v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
- *
v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream
- * where last buffer being read, if not completely full, was not returned.
- *
v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
- *
v1.3.3 - Fixed I/O streams which were totally messed up.
- *
- *
- *
- * I am placing this code in the Public Domain. Do with it as you will.
- * This software comes with no guarantees or warranties but with
- * plenty of well-wishing instead!
- * Please visit http://iharder.net/base64
- * periodically to check for updates or to contribute improvements.
- *
- *
- * @author Robert Harder
- * @author rob@iharder.net
- * @version 2.3.7
- */
-public class Base64
-{
-
-/* ******** P U B L I C F I E L D S ******** */
-
-
- /** No options specified. Value is zero. */
- public final static int NO_OPTIONS = 0;
-
- /** Specify encoding in first bit. Value is one. */
- public final static int ENCODE = 1;
-
-
- /** Specify decoding in first bit. Value is zero. */
- public final static int DECODE = 0;
-
-
- /** Specify that data should be gzip-compressed in second bit. Value is two. */
- public final static int GZIP = 2;
-
- /** Specify that data should be gunzipped. */
- public final static int GUNZIP = 4;
-
- /** Do break lines when encoding. Value is 8. */
- public final static int DO_BREAK_LINES = 8;
-
- /**
- * Encode using Base64-like encoding that is URL- and Filename-safe as described
- * in Section 4 of RFC3548:
- * http://www.faqs.org/rfcs/rfc3548.html.
- * It is important to note that data encoded this way is not officially valid Base64,
- * or at the very least should not be called Base64 without also specifying that it
- * was encoded using the URL- and Filename-safe dialect.
- */
- public final static int URL_SAFE = 16;
-
-
- /**
- * Encode using the special "ordered" dialect of Base64 described here:
- * http://www.faqs.org/qa/rfcc-1940.html.
- */
- public final static int ORDERED = 32;
-
-
-/* ******** P R I V A T E F I E L D S ******** */
-
-
- /** Maximum line length (76) of Base64 output. */
- private final static int MAX_LINE_LENGTH = 76;
-
-
- /** The equals sign (=) as a byte. */
- private final static byte EQUALS_SIGN = (byte)'=';
-
-
- /** The new line character (\n) as a byte. */
- private final static byte NEW_LINE = (byte)'\n';
-
-
- /** Preferred encoding. */
- private final static String PREFERRED_ENCODING = "US-ASCII";
-
-
- private final static byte WHITE_SPACE_ENC = -5; // Indicates white space in encoding
- private final static byte EQUALS_SIGN_ENC = -1; // Indicates equals sign in encoding
-
-
-/* ******** S T A N D A R D B A S E 6 4 A L P H A B E T ******** */
-
- /** The 64 valid Base64 values. */
- /* Host platform me be something funny like EBCDIC, so we hardcode these values. */
- private final static byte[] _STANDARD_ALPHABET = {
- (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G',
- (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N',
- (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U',
- (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z',
- (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g',
- (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n',
- (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u',
- (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z',
- (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5',
- (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'+', (byte)'/'
- };
-
-
- /**
- * Translates a Base64 value to either its 6-bit reconstruction value
- * or a negative number indicating some other meaning.
- **/
- private final static byte[] _STANDARD_DECODABET = {
- -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8
- -5,-5, // Whitespace: Tab and Linefeed
- -9,-9, // Decimal 11 - 12
- -5, // Whitespace: Carriage Return
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26
- -9,-9,-9,-9,-9, // Decimal 27 - 31
- -5, // Whitespace: Space
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42
- 62, // Plus sign at decimal 43
- -9,-9,-9, // Decimal 44 - 46
- 63, // Slash at decimal 47
- 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine
- -9,-9,-9, // Decimal 58 - 60
- -1, // Equals sign at decimal 61
- -9,-9,-9, // Decimal 62 - 64
- 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N'
- 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z'
- -9,-9,-9,-9,-9,-9, // Decimal 91 - 96
- 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm'
- 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z'
- -9,-9,-9,-9,-9 // Decimal 123 - 127
- ,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255
- };
-
-
-/* ******** U R L S A F E B A S E 6 4 A L P H A B E T ******** */
-
- /**
- * Used in the URL- and Filename-safe dialect described in Section 4 of RFC3548:
- * http://www.faqs.org/rfcs/rfc3548.html.
- * Notice that the last two bytes become "hyphen" and "underscore" instead of "plus" and "slash."
- */
- private final static byte[] _URL_SAFE_ALPHABET = {
- (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G',
- (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N',
- (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U',
- (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z',
- (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g',
- (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n',
- (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u',
- (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z',
- (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5',
- (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'-', (byte)'_'
- };
-
- /**
- * Used in decoding URL- and Filename-safe dialects of Base64.
- */
- private final static byte[] _URL_SAFE_DECODABET = {
- -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8
- -5,-5, // Whitespace: Tab and Linefeed
- -9,-9, // Decimal 11 - 12
- -5, // Whitespace: Carriage Return
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26
- -9,-9,-9,-9,-9, // Decimal 27 - 31
- -5, // Whitespace: Space
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42
- -9, // Plus sign at decimal 43
- -9, // Decimal 44
- 62, // Minus sign at decimal 45
- -9, // Decimal 46
- -9, // Slash at decimal 47
- 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine
- -9,-9,-9, // Decimal 58 - 60
- -1, // Equals sign at decimal 61
- -9,-9,-9, // Decimal 62 - 64
- 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N'
- 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z'
- -9,-9,-9,-9, // Decimal 91 - 94
- 63, // Underscore at decimal 95
- -9, // Decimal 96
- 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm'
- 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z'
- -9,-9,-9,-9,-9 // Decimal 123 - 127
- ,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255
- };
-
-
-
-/* ******** O R D E R E D B A S E 6 4 A L P H A B E T ******** */
-
- /**
- * I don't get the point of this technique, but someone requested it,
- * and it is described here:
- * http://www.faqs.org/qa/rfcc-1940.html.
- */
- private final static byte[] _ORDERED_ALPHABET = {
- (byte)'-',
- (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4',
- (byte)'5', (byte)'6', (byte)'7', (byte)'8', (byte)'9',
- (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G',
- (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N',
- (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U',
- (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z',
- (byte)'_',
- (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g',
- (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n',
- (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u',
- (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z'
- };
-
- /**
- * Used in decoding the "ordered" dialect of Base64.
- */
- private final static byte[] _ORDERED_DECODABET = {
- -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8
- -5,-5, // Whitespace: Tab and Linefeed
- -9,-9, // Decimal 11 - 12
- -5, // Whitespace: Carriage Return
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26
- -9,-9,-9,-9,-9, // Decimal 27 - 31
- -5, // Whitespace: Space
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42
- -9, // Plus sign at decimal 43
- -9, // Decimal 44
- 0, // Minus sign at decimal 45
- -9, // Decimal 46
- -9, // Slash at decimal 47
- 1,2,3,4,5,6,7,8,9,10, // Numbers zero through nine
- -9,-9,-9, // Decimal 58 - 60
- -1, // Equals sign at decimal 61
- -9,-9,-9, // Decimal 62 - 64
- 11,12,13,14,15,16,17,18,19,20,21,22,23, // Letters 'A' through 'M'
- 24,25,26,27,28,29,30,31,32,33,34,35,36, // Letters 'N' through 'Z'
- -9,-9,-9,-9, // Decimal 91 - 94
- 37, // Underscore at decimal 95
- -9, // Decimal 96
- 38,39,40,41,42,43,44,45,46,47,48,49,50, // Letters 'a' through 'm'
- 51,52,53,54,55,56,57,58,59,60,61,62,63, // Letters 'n' through 'z'
- -9,-9,-9,-9,-9 // Decimal 123 - 127
- ,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243
- -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255
- };
-
-
-/* ******** D E T E R M I N E W H I C H A L H A B E T ******** */
-
-
- /**
- * Returns one of the _SOMETHING_ALPHABET byte arrays depending on
- * the options specified.
- * It's possible, though silly, to specify ORDERED and URLSAFE
- * in which case one of them will be picked, though there is
- * no guarantee as to which one will be picked.
- */
- private final static byte[] getAlphabet( int options ) {
- if ((options & URL_SAFE) == URL_SAFE) {
- return _URL_SAFE_ALPHABET;
- } else if ((options & ORDERED) == ORDERED) {
- return _ORDERED_ALPHABET;
- } else {
- return _STANDARD_ALPHABET;
- }
- } // end getAlphabet
-
-
- /**
- * Returns one of the _SOMETHING_DECODABET byte arrays depending on
- * the options specified.
- * It's possible, though silly, to specify ORDERED and URL_SAFE
- * in which case one of them will be picked, though there is
- * no guarantee as to which one will be picked.
- */
- private final static byte[] getDecodabet( int options ) {
- if( (options & URL_SAFE) == URL_SAFE) {
- return _URL_SAFE_DECODABET;
- } else if ((options & ORDERED) == ORDERED) {
- return _ORDERED_DECODABET;
- } else {
- return _STANDARD_DECODABET;
- }
- } // end getAlphabet
-
-
-
- /** Defeats instantiation. */
- private Base64(){}
-
-
-
-
-/* ******** E N C O D I N G M E T H O D S ******** */
-
-
- /**
- * Encodes up to the first three bytes of array threeBytes
- * and returns a four-byte array in Base64 notation.
- * The actual number of significant bytes in your array is
- * given by numSigBytes.
- * The array threeBytes needs only be as big as
- * numSigBytes.
- * Code can reuse a byte array by passing a four-byte array as b4.
- *
- * @param b4 A reusable byte array to reduce array instantiation
- * @param threeBytes the array to convert
- * @param numSigBytes the number of significant bytes in your array
- * @return four byte array in Base64 notation.
- * @since 1.5.1
- */
- private static byte[] encode3to4( byte[] b4, byte[] threeBytes, int numSigBytes, int options ) {
- encode3to4( threeBytes, 0, numSigBytes, b4, 0, options );
- return b4;
- } // end encode3to4
-
-
- /**
- *
Encodes up to three bytes of the array source
- * and writes the resulting four Base64 bytes to destination.
- * The source and destination arrays can be manipulated
- * anywhere along their length by specifying
- * srcOffset and destOffset.
- * This method does not check to make sure your arrays
- * are large enough to accommodate srcOffset + 3 for
- * the source array or destOffset + 4 for
- * the destination array.
- * The actual number of significant bytes in your array is
- * given by numSigBytes.
- *
This is the lowest level of the encoding methods with
- * all possible parameters.
- *
- * @param source the array to convert
- * @param srcOffset the index where conversion begins
- * @param numSigBytes the number of significant bytes in your array
- * @param destination the array to hold the conversion
- * @param destOffset the index where output will be put
- * @return the destination array
- * @since 1.3
- */
- private static byte[] encode3to4(
- byte[] source, int srcOffset, int numSigBytes,
- byte[] destination, int destOffset, int options ) {
-
- byte[] ALPHABET = getAlphabet( options );
-
- // 1 2 3
- // 01234567890123456789012345678901 Bit position
- // --------000000001111111122222222 Array position from threeBytes
- // --------| || || || | Six bit groups to index ALPHABET
- // >>18 >>12 >> 6 >> 0 Right shift necessary
- // 0x3f 0x3f 0x3f Additional AND
-
- // Create buffer with zero-padding if there are only one or two
- // significant bytes passed in the array.
- // We have to shift left 24 in order to flush out the 1's that appear
- // when Java treats a value as negative that is cast from a byte to an int.
- int inBuff = ( numSigBytes > 0 ? ((source[ srcOffset ] << 24) >>> 8) : 0 )
- | ( numSigBytes > 1 ? ((source[ srcOffset + 1 ] << 24) >>> 16) : 0 )
- | ( numSigBytes > 2 ? ((source[ srcOffset + 2 ] << 24) >>> 24) : 0 );
-
- switch( numSigBytes )
- {
- case 3:
- destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ];
- destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ];
- destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ];
- destination[ destOffset + 3 ] = ALPHABET[ (inBuff ) & 0x3f ];
- return destination;
-
- case 2:
- destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ];
- destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ];
- destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ];
- destination[ destOffset + 3 ] = EQUALS_SIGN;
- return destination;
-
- case 1:
- destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ];
- destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ];
- destination[ destOffset + 2 ] = EQUALS_SIGN;
- destination[ destOffset + 3 ] = EQUALS_SIGN;
- return destination;
-
- default:
- return destination;
- } // end switch
- } // end encode3to4
-
-
-
- /**
- * Performs Base64 encoding on the raw ByteBuffer,
- * writing it to the encoded ByteBuffer.
- * This is an experimental feature. Currently it does not
- * pass along any options (such as {@link #DO_BREAK_LINES}
- * or {@link #GZIP}).
- *
- * @param raw input buffer
- * @param encoded output buffer
- * @since 2.3
- */
- public static void encode( java.nio.ByteBuffer raw, java.nio.ByteBuffer encoded ){
- byte[] raw3 = new byte[3];
- byte[] enc4 = new byte[4];
-
- while( raw.hasRemaining() ){
- int rem = Math.min(3,raw.remaining());
- raw.get(raw3,0,rem);
- Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS);
- encoded.put(enc4);
- } // end input remaining
- }
-
-
- /**
- * Performs Base64 encoding on the raw ByteBuffer,
- * writing it to the encoded CharBuffer.
- * This is an experimental feature. Currently it does not
- * pass along any options (such as {@link #DO_BREAK_LINES}
- * or {@link #GZIP}.
- *
- * @param raw input buffer
- * @param encoded output buffer
- * @since 2.3
- */
- public static void encode( java.nio.ByteBuffer raw, java.nio.CharBuffer encoded ){
- byte[] raw3 = new byte[3];
- byte[] enc4 = new byte[4];
-
- while( raw.hasRemaining() ){
- int rem = Math.min(3,raw.remaining());
- raw.get(raw3,0,rem);
- Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS );
- for( int i = 0; i < 4; i++ ){
- encoded.put( (char)(enc4[i] & 0xFF) );
- }
- } // end input remaining
- }
-
-
-
-
- /**
- * Serializes an object and returns the Base64-encoded
- * version of that serialized object.
- *
- *
As of v 2.3, if the object
- * cannot be serialized or there is another error,
- * the method will throw an java.io.IOException. This is new to v2.3!
- * In earlier versions, it just returned a null value, but
- * in retrospect that's a pretty poor way to handle it.
- *
- * The object is not GZip-compressed before being encoded.
- *
- * @param serializableObject The object to encode
- * @return The Base64-encoded object
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if serializedObject is null
- * @since 1.4
- */
- public static String encodeObject( java.io.Serializable serializableObject )
- throws java.io.IOException {
- return encodeObject( serializableObject, NO_OPTIONS );
- } // end encodeObject
-
-
-
- /**
- * Serializes an object and returns the Base64-encoded
- * version of that serialized object.
- *
- *
As of v 2.3, if the object
- * cannot be serialized or there is another error,
- * the method will throw an java.io.IOException. This is new to v2.3!
- * In earlier versions, it just returned a null value, but
- * in retrospect that's a pretty poor way to handle it.
- *
- * The object is not GZip-compressed before being encoded.
- *
- * Example options:
- * GZIP: gzip-compresses object before encoding it.
- * DO_BREAK_LINES: break lines at 76 characters
- *
- *
- * Example: encodeObject( myObj, Base64.GZIP ) or
- *
- * Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES )
- *
- * @param serializableObject The object to encode
- * @param options Specified options
- * @return The Base64-encoded object
- * @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @since 2.0
- */
- public static String encodeObject( java.io.Serializable serializableObject, int options )
- throws java.io.IOException {
-
- if( serializableObject == null ){
- throw new NullPointerException( "Cannot serialize a null object." );
- } // end if: null
-
- // Streams
- java.io.ByteArrayOutputStream baos = null;
- java.io.OutputStream b64os = null;
- java.util.zip.GZIPOutputStream gzos = null;
- java.io.ObjectOutputStream oos = null;
-
-
- try {
- // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream
- baos = new java.io.ByteArrayOutputStream();
- b64os = new Base64.OutputStream( baos, ENCODE | options );
- if( (options & GZIP) != 0 ){
- // Gzip
- gzos = new java.util.zip.GZIPOutputStream(b64os);
- oos = new java.io.ObjectOutputStream( gzos );
- } else {
- // Not gzipped
- oos = new java.io.ObjectOutputStream( b64os );
- }
- oos.writeObject( serializableObject );
- } // end try
- catch( java.io.IOException e ) {
- // Catch it and then throw it immediately so that
- // the finally{} block is called for cleanup.
- throw e;
- } // end catch
- finally {
- try{ oos.close(); } catch( Exception e ){}
- try{ gzos.close(); } catch( Exception e ){}
- try{ b64os.close(); } catch( Exception e ){}
- try{ baos.close(); } catch( Exception e ){}
- } // end finally
-
- // Return value according to relevant encoding.
- try {
- return new String( baos.toByteArray(), PREFERRED_ENCODING );
- } // end try
- catch (java.io.UnsupportedEncodingException uue){
- // Fall back to some Java default
- return new String( baos.toByteArray() );
- } // end catch
-
- } // end encode
-
-
-
- /**
- * Encodes a byte array into Base64 notation.
- * Does not GZip-compress data.
- *
- * @param source The data to convert
- * @return The data in Base64-encoded form
- * @throws NullPointerException if source array is null
- * @since 1.4
- */
- public static String encodeBytes( byte[] source ) {
- // Since we're not going to have the GZIP encoding turned on,
- // we're not going to have an java.io.IOException thrown, so
- // we should not force the user to have to catch it.
- String encoded = null;
- try {
- encoded = encodeBytes(source, 0, source.length, NO_OPTIONS);
- } catch (java.io.IOException ex) {
- assert false : ex.getMessage();
- } // end catch
- assert encoded != null;
- return encoded;
- } // end encodeBytes
-
-
-
- /**
- * Encodes a byte array into Base64 notation.
- *
- * Example options:
- * GZIP: gzip-compresses object before encoding it.
- * DO_BREAK_LINES: break lines at 76 characters
- * Note: Technically, without line break your encoding may become non-compliant (see rfc2045 and rfc4648).
- *
- *
- * Example: encodeBytes( myData, Base64.GZIP ) or
- *
As of v 2.3, if there is an error with the GZIP stream,
- * the method will throw an java.io.IOException. This is new to v2.3!
- * In earlier versions, it just returned a null value, but
- * in retrospect that's a pretty poor way to handle it.
- *
- *
- * @param source The data to convert
- * @param options Specified options
- * @return The Base64-encoded data as a String
- * @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if source array is null
- * @since 2.0
- */
- public static String encodeBytes( byte[] source, int options ) throws java.io.IOException {
- return encodeBytes( source, 0, source.length, options );
- } // end encodeBytes
-
-
- /**
- * Encodes a byte array into Base64 notation.
- * Does not GZip-compress data.
- *
- *
As of v 2.3, if there is an error,
- * the method will throw an java.io.IOException. This is new to v2.3!
- * In earlier versions, it just returned a null value, but
- * in retrospect that's a pretty poor way to handle it.
- *
- *
- * @param source The data to convert
- * @param off Offset in array where conversion should begin
- * @param len Length of data to convert
- * @return The Base64-encoded data as a String
- * @throws NullPointerException if source array is null
- * @throws IllegalArgumentException if source array, offset, or length are invalid
- * @since 1.4
- */
- public static String encodeBytes( byte[] source, int off, int len ) {
- // Since we're not going to have the GZIP encoding turned on,
- // we're not going to have an java.io.IOException thrown, so
- // we should not force the user to have to catch it.
- String encoded = null;
- try {
- encoded = encodeBytes( source, off, len, NO_OPTIONS );
- } catch (java.io.IOException ex) {
- assert false : ex.getMessage();
- } // end catch
- assert encoded != null;
- return encoded;
- } // end encodeBytes
-
-
-
- /**
- * Encodes a byte array into Base64 notation.
- *
- * Example options:
- * GZIP: gzip-compresses object before encoding it.
- * DO_BREAK_LINES: break lines at 76 characters
- * Note: Technically, this makes your encoding non-compliant.
- *
- *
- * Example: encodeBytes( myData, Base64.GZIP ) or
- *
As of v 2.3, if there is an error with the GZIP stream,
- * the method will throw an java.io.IOException. This is new to v2.3!
- * In earlier versions, it just returned a null value, but
- * in retrospect that's a pretty poor way to handle it.
- *
- *
- * @param source The data to convert
- * @param off Offset in array where conversion should begin
- * @param len Length of data to convert
- * @param options Specified options
- * @return The Base64-encoded data as a String
- * @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if source array is null
- * @throws IllegalArgumentException if source array, offset, or length are invalid
- * @since 2.0
- */
- public static String encodeBytes( byte[] source, int off, int len, int options ) throws java.io.IOException {
- byte[] encoded = encodeBytesToBytes( source, off, len, options );
-
- // Return value according to relevant encoding.
- try {
- return new String( encoded, PREFERRED_ENCODING );
- } // end try
- catch (java.io.UnsupportedEncodingException uue) {
- return new String( encoded );
- } // end catch
-
- } // end encodeBytes
-
-
-
-
- /**
- * Similar to {@link #encodeBytes(byte[])} but returns
- * a byte array instead of instantiating a String. This is more efficient
- * if you're working with I/O streams and have large data sets to encode.
- *
- *
- * @param source The data to convert
- * @return The Base64-encoded data as a byte[] (of ASCII characters)
- * @throws NullPointerException if source array is null
- * @since 2.3.1
- */
- public static byte[] encodeBytesToBytes( byte[] source ) {
- byte[] encoded = null;
- try {
- encoded = encodeBytesToBytes( source, 0, source.length, Base64.NO_OPTIONS );
- } catch( java.io.IOException ex ) {
- assert false : "IOExceptions only come from GZipping, which is turned off: " + ex.getMessage();
- }
- return encoded;
- }
-
-
- /**
- * Similar to {@link #encodeBytes(byte[], int, int, int)} but returns
- * a byte array instead of instantiating a String. This is more efficient
- * if you're working with I/O streams and have large data sets to encode.
- *
- *
- * @param source The data to convert
- * @param off Offset in array where conversion should begin
- * @param len Length of data to convert
- * @param options Specified options
- * @return The Base64-encoded data as a String
- * @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if source array is null
- * @throws IllegalArgumentException if source array, offset, or length are invalid
- * @since 2.3.1
- */
- public static byte[] encodeBytesToBytes( byte[] source, int off, int len, int options ) throws java.io.IOException {
-
- if( source == null ){
- throw new NullPointerException( "Cannot serialize a null array." );
- } // end if: null
-
- if( off < 0 ){
- throw new IllegalArgumentException( "Cannot have negative offset: " + off );
- } // end if: off < 0
-
- if( len < 0 ){
- throw new IllegalArgumentException( "Cannot have length offset: " + len );
- } // end if: len < 0
-
- if( off + len > source.length ){
- throw new IllegalArgumentException(
- String.format( "Cannot have offset of %d and length of %d with array of length %d", off,len,source.length));
- } // end if: off < 0
-
-
-
- // Compress?
- if( (options & GZIP) != 0 ) {
- java.io.ByteArrayOutputStream baos = null;
- java.util.zip.GZIPOutputStream gzos = null;
- Base64.OutputStream b64os = null;
-
- try {
- // GZip -> Base64 -> ByteArray
- baos = new java.io.ByteArrayOutputStream();
- b64os = new Base64.OutputStream( baos, ENCODE | options );
- gzos = new java.util.zip.GZIPOutputStream( b64os );
-
- gzos.write( source, off, len );
- gzos.close();
- } // end try
- catch( java.io.IOException e ) {
- // Catch it and then throw it immediately so that
- // the finally{} block is called for cleanup.
- throw e;
- } // end catch
- finally {
- try{ gzos.close(); } catch( Exception e ){}
- try{ b64os.close(); } catch( Exception e ){}
- try{ baos.close(); } catch( Exception e ){}
- } // end finally
-
- return baos.toByteArray();
- } // end if: compress
-
- // Else, don't compress. Better not to use streams at all then.
- else {
- boolean breakLines = (options & DO_BREAK_LINES) != 0;
-
- //int len43 = len * 4 / 3;
- //byte[] outBuff = new byte[ ( len43 ) // Main 4:3
- // + ( (len % 3) > 0 ? 4 : 0 ) // Account for padding
- // + (breakLines ? ( len43 / MAX_LINE_LENGTH ) : 0) ]; // New lines
- // Try to determine more precisely how big the array needs to be.
- // If we get it right, we don't have to do an array copy, and
- // we save a bunch of memory.
- int encLen = ( len / 3 ) * 4 + ( len % 3 > 0 ? 4 : 0 ); // Bytes needed for actual encoding
- if( breakLines ){
- encLen += encLen / MAX_LINE_LENGTH; // Plus extra newline characters
- }
- byte[] outBuff = new byte[ encLen ];
-
-
- int d = 0;
- int e = 0;
- int len2 = len - 2;
- int lineLength = 0;
- for( ; d < len2; d+=3, e+=4 ) {
- encode3to4( source, d+off, 3, outBuff, e, options );
-
- lineLength += 4;
- if( breakLines && lineLength >= MAX_LINE_LENGTH )
- {
- outBuff[e+4] = NEW_LINE;
- e++;
- lineLength = 0;
- } // end if: end of line
- } // en dfor: each piece of array
-
- if( d < len ) {
- encode3to4( source, d+off, len - d, outBuff, e, options );
- e += 4;
- } // end if: some padding needed
-
-
- // Only resize array if we didn't guess it right.
- if( e <= outBuff.length - 1 ){
- // If breaking lines and the last byte falls right at
- // the line length (76 bytes per line), there will be
- // one extra byte, and the array will need to be resized.
- // Not too bad of an estimate on array size, I'd say.
- byte[] finalOut = new byte[e];
- System.arraycopy(outBuff,0, finalOut,0,e);
- //System.err.println("Having to resize array from " + outBuff.length + " to " + e );
- return finalOut;
- } else {
- //System.err.println("No need to resize array.");
- return outBuff;
- }
-
- } // end else: don't compress
-
- } // end encodeBytesToBytes
-
-
-
-
-
-/* ******** D E C O D I N G M E T H O D S ******** */
-
-
- /**
- * Decodes four bytes from array source
- * and writes the resulting bytes (up to three of them)
- * to destination.
- * The source and destination arrays can be manipulated
- * anywhere along their length by specifying
- * srcOffset and destOffset.
- * This method does not check to make sure your arrays
- * are large enough to accommodate srcOffset + 4 for
- * the source array or destOffset + 3 for
- * the destination array.
- * This method returns the actual number of bytes that
- * were converted from the Base64 encoding.
- *
This is the lowest level of the decoding methods with
- * all possible parameters.
- *
- *
- * @param source the array to convert
- * @param srcOffset the index where conversion begins
- * @param destination the array to hold the conversion
- * @param destOffset the index where output will be put
- * @param options alphabet type is pulled from this (standard, url-safe, ordered)
- * @return the number of decoded bytes converted
- * @throws NullPointerException if source or destination arrays are null
- * @throws IllegalArgumentException if srcOffset or destOffset are invalid
- * or there is not enough room in the array.
- * @since 1.3
- */
- private static int decode4to3(
- byte[] source, int srcOffset,
- byte[] destination, int destOffset, int options ) {
-
- // Lots of error checking and exception throwing
- if( source == null ){
- throw new NullPointerException( "Source array was null." );
- } // end if
- if( destination == null ){
- throw new NullPointerException( "Destination array was null." );
- } // end if
- if( srcOffset < 0 || srcOffset + 3 >= source.length ){
- throw new IllegalArgumentException( String.format(
- "Source array with length %d cannot have offset of %d and still process four bytes.", source.length, srcOffset ) );
- } // end if
- if( destOffset < 0 || destOffset +2 >= destination.length ){
- throw new IllegalArgumentException( String.format(
- "Destination array with length %d cannot have offset of %d and still store three bytes.", destination.length, destOffset ) );
- } // end if
-
-
- byte[] DECODABET = getDecodabet( options );
-
- // Example: Dk==
- if( source[ srcOffset + 2] == EQUALS_SIGN ) {
- // Two ways to do the same thing. Don't know which way I like best.
- //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 )
- // | ( ( DECODABET[ source[ srcOffset + 1] ] << 24 ) >>> 12 );
- int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 )
- | ( ( DECODABET[ source[ srcOffset + 1] ] & 0xFF ) << 12 );
-
- destination[ destOffset ] = (byte)( outBuff >>> 16 );
- return 1;
- }
-
- // Example: DkL=
- else if( source[ srcOffset + 3 ] == EQUALS_SIGN ) {
- // Two ways to do the same thing. Don't know which way I like best.
- //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 )
- // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 )
- // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 );
- int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 )
- | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 )
- | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6 );
-
- destination[ destOffset ] = (byte)( outBuff >>> 16 );
- destination[ destOffset + 1 ] = (byte)( outBuff >>> 8 );
- return 2;
- }
-
- // Example: DkLE
- else {
- // Two ways to do the same thing. Don't know which way I like best.
- //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 )
- // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 )
- // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 )
- // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 );
- int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 )
- | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 )
- | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6)
- | ( ( DECODABET[ source[ srcOffset + 3 ] ] & 0xFF ) );
-
-
- destination[ destOffset ] = (byte)( outBuff >> 16 );
- destination[ destOffset + 1 ] = (byte)( outBuff >> 8 );
- destination[ destOffset + 2 ] = (byte)( outBuff );
-
- return 3;
- }
- } // end decodeToBytes
-
-
-
-
-
- /**
- * Low-level access to decoding ASCII characters in
- * the form of a byte array. Ignores GUNZIP option, if
- * it's set. This is not generally a recommended method,
- * although it is used internally as part of the decoding process.
- * Special case: if len = 0, an empty array is returned. Still,
- * if you need more speed and reduced memory footprint (and aren't
- * gzipping), consider this method.
- *
- * @param source The Base64 encoded data
- * @return decoded data
- * @since 2.3.1
- */
- public static byte[] decode( byte[] source ) throws java.io.IOException {
- return decode( source, 0, source.length, Base64.NO_OPTIONS );
- }
-
-
-
- /**
- * Low-level access to decoding ASCII characters in
- * the form of a byte array. Ignores GUNZIP option, if
- * it's set. This is not generally a recommended method,
- * although it is used internally as part of the decoding process.
- * Special case: if len = 0, an empty array is returned. Still,
- * if you need more speed and reduced memory footprint (and aren't
- * gzipping), consider this method.
- *
- * @param source The Base64 encoded data
- * @param off The offset of where to begin decoding
- * @param len The length of characters to decode
- * @param options Can specify options such as alphabet type to use
- * @return decoded data
- * @throws java.io.IOException If bogus characters exist in source data
- * @since 1.3
- */
- public static byte[] decode( byte[] source, int off, int len, int options )
- throws java.io.IOException {
-
- // Lots of error checking and exception throwing
- if( source == null ){
- throw new NullPointerException( "Cannot decode null source array." );
- } // end if
- if( off < 0 || off + len > source.length ){
- throw new IllegalArgumentException( String.format(
- "Source array with length %d cannot have offset of %d and process %d bytes.", source.length, off, len ) );
- } // end if
-
- if( len == 0 ){
- return new byte[0];
- }else if( len < 4 ){
- throw new IllegalArgumentException(
- "Base64-encoded string must have at least four characters, but length specified was " + len );
- } // end if
-
- byte[] DECODABET = getDecodabet( options );
-
- int len34 = len * 3 / 4; // Estimate on array size
- byte[] outBuff = new byte[ len34 ]; // Upper limit on size of output
- int outBuffPosn = 0; // Keep track of where we're writing
-
- byte[] b4 = new byte[4]; // Four byte buffer from source, eliminating white space
- int b4Posn = 0; // Keep track of four byte input buffer
- int i = 0; // Source array counter
- byte sbiDecode = 0; // Special value from DECODABET
-
- for( i = off; i < off+len; i++ ) { // Loop through source
-
- sbiDecode = DECODABET[ source[i]&0xFF ];
-
- // White space, Equals sign, or legit Base64 character
- // Note the values such as -5 and -9 in the
- // DECODABETs at the top of the file.
- if( sbiDecode >= WHITE_SPACE_ENC ) {
- if( sbiDecode >= EQUALS_SIGN_ENC ) {
- b4[ b4Posn++ ] = source[i]; // Save non-whitespace
- if( b4Posn > 3 ) { // Time to decode?
- outBuffPosn += decode4to3( b4, 0, outBuff, outBuffPosn, options );
- b4Posn = 0;
-
- // If that was the equals sign, break out of 'for' loop
- if( source[i] == EQUALS_SIGN ) {
- break;
- } // end if: equals sign
- } // end if: quartet built
- } // end if: equals sign or better
- } // end if: white space, equals sign or better
- else {
- // There's a bad input character in the Base64 stream.
- throw new java.io.IOException( String.format(
- "Bad Base64 input character decimal %d in array position %d", ((int)source[i])&0xFF, i ) );
- } // end else:
- } // each input character
-
- byte[] out = new byte[ outBuffPosn ];
- System.arraycopy( outBuff, 0, out, 0, outBuffPosn );
- return out;
- } // end decode
-
-
-
-
- /**
- * Decodes data from Base64 notation, automatically
- * detecting gzip-compressed data and decompressing it.
- *
- * @param s the string to decode
- * @return the decoded data
- * @throws java.io.IOException If there is a problem
- * @since 1.4
- */
- public static byte[] decode( String s ) throws java.io.IOException {
- return decode( s, NO_OPTIONS );
- }
-
-
-
- /**
- * Decodes data from Base64 notation, automatically
- * detecting gzip-compressed data and decompressing it.
- *
- * @param s the string to decode
- * @param options decode options such as URL_SAFE or GUNZIP
- * @return the decoded data
- * @throws java.io.IOException if there is an error (invalid character in source string or gunzip error)
- * @throws NullPointerException if s is null
- * @since 1.4
- */
- public static byte[] decode( String s, int options ) throws java.io.IOException {
-
- if( s == null ){
- throw new NullPointerException( "Input string was null." );
- } // end if
-
- byte[] bytes;
- try {
- bytes = s.getBytes( PREFERRED_ENCODING );
- } // end try
- catch( java.io.UnsupportedEncodingException uee ) {
- bytes = s.getBytes();
- } // end catch
- //
-
- // Decode
- bytes = decode( bytes, 0, bytes.length, options );
-
- // Check to see if it's gzip-compressed
- // GZIP Magic Two-Byte Number: 0x8b1f (35615)
- boolean doGunzip = (options & GUNZIP) != 0;
- if( (bytes != null) && (bytes.length >= 4) && doGunzip ) {
-
- int head = ((int)bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00);
- if( java.util.zip.GZIPInputStream.GZIP_MAGIC != head ) {
- throw new IOException("Provided data has no GZIP magic header.");
- }
- java.io.ByteArrayInputStream bais = null;
- java.util.zip.GZIPInputStream gzis = null;
- java.io.ByteArrayOutputStream baos = null;
- byte[] buffer = new byte[2048];
- int length = 0;
-
- try {
- baos = new java.io.ByteArrayOutputStream();
- bais = new java.io.ByteArrayInputStream( bytes );
- gzis = new java.util.zip.GZIPInputStream( bais );
-
- while( ( length = gzis.read( buffer ) ) >= 0 ) {
- baos.write(buffer,0,length);
- } // end while: reading input
-
- // No error? Get new bytes.
- bytes = baos.toByteArray();
-
- } // end try
- catch( java.io.IOException e ) {
- throw new IOException("Failed to gunzip", e);
- } // end catch
- finally {
- try{ baos.close(); } catch( Exception e ){}
- try{ gzis.close(); } catch( Exception e ){}
- try{ bais.close(); } catch( Exception e ){}
- } // end finally
-
- } // end if: bytes.length >= 2
-
- return bytes;
- } // end decode
-
- /* ******** I N N E R C L A S S I N P U T S T R E A M ******** */
-
- /**
- * A {@link Base64.InputStream} will read data from another
- * java.io.InputStream, given in the constructor,
- * and encode/decode to/from Base64 notation on the fly.
- *
- * @see Base64
- * @since 1.3
- */
- public static class InputStream extends java.io.FilterInputStream {
-
- private boolean encode; // Encoding or decoding
- private int position; // Current position in the buffer
- private byte[] buffer; // Small buffer holding converted data
- private int bufferLength; // Length of buffer (3 or 4)
- private int numSigBytes; // Number of meaningful bytes in the buffer
- private int lineLength;
- private boolean breakLines; // Break lines at less than 80 characters
- private int options; // Record options used to create the stream.
- private byte[] decodabet; // Local copies to avoid extra method calls
-
-
- /**
- * Constructs a {@link Base64.InputStream} in DECODE mode.
- *
- * @param in the java.io.InputStream from which to read data.
- * @since 1.3
- */
- public InputStream( java.io.InputStream in ) {
- this( in, DECODE );
- } // end constructor
-
-
- /**
- * Constructs a {@link Base64.InputStream} in
- * either ENCODE or DECODE mode.
- *
- * Valid options:
- * ENCODE or DECODE: Encode or Decode as data is read.
- * DO_BREAK_LINES: break lines at 76 characters
- * (only meaningful when encoding)
- *
- *
- * Example: new Base64.InputStream( in, Base64.DECODE )
- *
- *
- * @param in the java.io.InputStream from which to read data.
- * @param options Specified options
- * @see Base64#ENCODE
- * @see Base64#DECODE
- * @see Base64#DO_BREAK_LINES
- * @since 2.0
- */
- public InputStream( java.io.InputStream in, int options ) {
-
- super( in );
- this.options = options; // Record for later
- this.breakLines = (options & DO_BREAK_LINES) > 0;
- this.encode = (options & ENCODE) > 0;
- this.bufferLength = encode ? 4 : 3;
- this.buffer = new byte[ bufferLength ];
- this.position = -1;
- this.lineLength = 0;
- this.decodabet = getDecodabet(options);
- } // end constructor
-
- /**
- * Reads enough of the input stream to convert
- * to/from Base64 and returns the next byte.
- *
- * @return next byte
- * @since 1.3
- */
- @Override
- public int read() throws java.io.IOException {
-
- // Do we need to get data?
- if( position < 0 ) {
- if( encode ) {
- byte[] b3 = new byte[3];
- int numBinaryBytes = 0;
- for( int i = 0; i < 3; i++ ) {
- int b = in.read();
-
- // If end of stream, b is -1.
- if( b >= 0 ) {
- b3[i] = (byte)b;
- numBinaryBytes++;
- } else {
- break; // out of for loop
- } // end else: end of stream
-
- } // end for: each needed input byte
-
- if( numBinaryBytes > 0 ) {
- encode3to4( b3, 0, numBinaryBytes, buffer, 0, options );
- position = 0;
- numSigBytes = 4;
- } // end if: got data
- else {
- return -1; // Must be end of stream
- } // end else
- } // end if: encoding
-
- // Else decoding
- else {
- byte[] b4 = new byte[4];
- int i = 0;
- for( i = 0; i < 4; i++ ) {
- // Read four "meaningful" bytes:
- int b = 0;
- do{ b = in.read(); }
- while( b >= 0 && decodabet[ b & 0x7f ] <= WHITE_SPACE_ENC );
-
- if( b < 0 ) {
- break; // Reads a -1 if end of stream
- } // end if: end of stream
-
- b4[i] = (byte)b;
- } // end for: each needed input byte
-
- if( i == 4 ) {
- numSigBytes = decode4to3( b4, 0, buffer, 0, options );
- position = 0;
- } // end if: got four characters
- else if( i == 0 ){
- return -1;
- } // end else if: also padded correctly
- else {
- // Must have broken out from above.
- throw new java.io.IOException( "Improperly padded Base64 input." );
- } // end
-
- } // end else: decode
- } // end else: get data
-
- // Got data?
- if( position >= 0 ) {
- // End of relevant data?
- if( /*!encode &&*/ position >= numSigBytes ){
- return -1;
- } // end if: got data
-
- if( encode && breakLines && lineLength >= MAX_LINE_LENGTH ) {
- lineLength = 0;
- return '\n';
- } // end if
- else {
- lineLength++; // This isn't important when decoding
- // but throwing an extra "if" seems
- // just as wasteful.
-
- int b = buffer[ position++ ];
-
- if( position >= bufferLength ) {
- position = -1;
- } // end if: end
-
- return b & 0xFF; // This is how you "cast" a byte that's
- // intended to be unsigned.
- } // end else
- } // end if: position >= 0
-
- // Else error
- else {
- throw new java.io.IOException( "Error in Base64 code reading stream." );
- } // end else
- } // end read
-
-
- /**
- * Calls {@link #read()} repeatedly until the end of stream
- * is reached or len bytes are read.
- * Returns number of bytes read into array or -1 if
- * end of stream is encountered.
- *
- * @param dest array to hold values
- * @param off offset for array
- * @param len max number of bytes to read into array
- * @return bytes read into array or -1 if end of stream is encountered.
- * @since 1.3
- */
- @Override
- public int read( byte[] dest, int off, int len )
- throws java.io.IOException {
- int i;
- int b;
- for( i = 0; i < len; i++ ) {
- b = read();
-
- if( b >= 0 ) {
- dest[off + i] = (byte) b;
- }
- else if( i == 0 ) {
- return -1;
- }
- else {
- break; // Out of 'for' loop
- } // Out of 'for' loop
- } // end for: each byte read
- return i;
- } // end read
-
- } // end inner class InputStream
-
-
-
-
-
-
- /* ******** I N N E R C L A S S O U T P U T S T R E A M ******** */
-
-
-
- /**
- * A {@link Base64.OutputStream} will write data to another
- * java.io.OutputStream, given in the constructor,
- * and encode/decode to/from Base64 notation on the fly.
- *
- * @see Base64
- * @since 1.3
- */
- public static class OutputStream extends java.io.FilterOutputStream {
-
- private boolean encode;
- private int position;
- private byte[] buffer;
- private int bufferLength;
- private int lineLength;
- private boolean breakLines;
- private byte[] b4; // Scratch used in a few places
- private boolean suspendEncoding;
- private int options; // Record for later
- private byte[] decodabet; // Local copies to avoid extra method calls
-
- /**
- * Constructs a {@link Base64.OutputStream} in ENCODE mode.
- *
- * @param out the java.io.OutputStream to which data will be written.
- * @since 1.3
- */
- public OutputStream( java.io.OutputStream out ) {
- this( out, ENCODE );
- } // end constructor
-
-
- /**
- * Constructs a {@link Base64.OutputStream} in
- * either ENCODE or DECODE mode.
- *
- * Valid options:
- * ENCODE or DECODE: Encode or Decode as data is read.
- * DO_BREAK_LINES: don't break lines at 76 characters
- * (only meaningful when encoding)
- *
- *
- * Example: new Base64.OutputStream( out, Base64.ENCODE )
- *
- * @param out the java.io.OutputStream to which data will be written.
- * @param options Specified options.
- * @see Base64#ENCODE
- * @see Base64#DECODE
- * @see Base64#DO_BREAK_LINES
- * @since 1.3
- */
- public OutputStream( java.io.OutputStream out, int options ) {
- super( out );
- this.breakLines = (options & DO_BREAK_LINES) != 0;
- this.encode = (options & ENCODE) != 0;
- this.bufferLength = encode ? 3 : 4;
- this.buffer = new byte[ bufferLength ];
- this.position = 0;
- this.lineLength = 0;
- this.suspendEncoding = false;
- this.b4 = new byte[4];
- this.options = options;
- this.decodabet = getDecodabet(options);
- } // end constructor
-
-
- /**
- * Writes the byte to the output stream after
- * converting to/from Base64 notation.
- * When encoding, bytes are buffered three
- * at a time before the output stream actually
- * gets a write() call.
- * When decoding, bytes are buffered four
- * at a time.
- *
- * @param theByte the byte to write
- * @since 1.3
- */
- @Override
- public void write(int theByte)
- throws java.io.IOException {
- // Encoding suspended?
- if( suspendEncoding ) {
- this.out.write( theByte );
- return;
- } // end if: supsended
-
- // Encode?
- if( encode ) {
- buffer[ position++ ] = (byte)theByte;
- if( position >= bufferLength ) { // Enough to encode.
-
- this.out.write( encode3to4( b4, buffer, bufferLength, options ) );
-
- lineLength += 4;
- if( breakLines && lineLength >= MAX_LINE_LENGTH ) {
- this.out.write( NEW_LINE );
- lineLength = 0;
- } // end if: end of line
-
- position = 0;
- } // end if: enough to output
- } // end if: encoding
-
- // Else, Decoding
- else {
- // Meaningful Base64 character?
- if( decodabet[ theByte & 0x7f ] > WHITE_SPACE_ENC ) {
- buffer[ position++ ] = (byte)theByte;
- if( position >= bufferLength ) { // Enough to output.
-
- int len = Base64.decode4to3( buffer, 0, b4, 0, options );
- out.write( b4, 0, len );
- position = 0;
- } // end if: enough to output
- } // end if: meaningful base64 character
- else if( decodabet[ theByte & 0x7f ] != WHITE_SPACE_ENC ) {
- throw new java.io.IOException( "Invalid character in Base64 data." );
- } // end else: not white space either
- } // end else: decoding
- } // end write
-
-
-
- /**
- * Calls {@link #write(int)} repeatedly until len
- * bytes are written.
- *
- * @param theBytes array from which to read bytes
- * @param off offset for array
- * @param len max number of bytes to read into array
- * @since 1.3
- */
- @Override
- public void write( byte[] theBytes, int off, int len )
- throws java.io.IOException {
- // Encoding suspended?
- if( suspendEncoding ) {
- this.out.write( theBytes, off, len );
- return;
- } // end if: supsended
-
- for( int i = 0; i < len; i++ ) {
- write( theBytes[ off + i ] );
- } // end for: each byte written
-
- } // end write
-
-
-
- /**
- * Method added by PHIL. [Thanks, PHIL. -Rob]
- * This pads the buffer without closing the stream.
- * @throws java.io.IOException if there's an error.
- */
- public void flushBase64() throws java.io.IOException {
- if( position > 0 ) {
- if( encode ) {
- out.write( encode3to4( b4, buffer, position, options ) );
- position = 0;
- } // end if: encoding
- else {
- throw new java.io.IOException( "Base64 input not properly padded." );
- } // end else: decoding
- } // end if: buffer partially full
-
- } // end flush
-
-
- /**
- * Flushes and closes (I think, in the superclass) the stream.
- *
- * @since 1.3
- */
- @Override
- public void close() throws java.io.IOException {
- // 1. Ensure that pending characters are written
- flushBase64();
-
- // 2. Actually close the stream
- // Base class both flushes and closes.
- super.close();
-
- buffer = null;
- out = null;
- } // end close
-
-
-
- /**
- * Suspends encoding of the stream.
- * May be helpful if you need to embed a piece of
- * base64-encoded data in a stream.
- *
- * @throws java.io.IOException if there's an error flushing
- * @since 1.5.1
- */
- public void suspendEncoding() throws java.io.IOException {
- flushBase64();
- this.suspendEncoding = true;
- } // end suspendEncoding
-
-
- /**
- * Resumes encoding of the stream.
- * May be helpful if you need to embed a piece of
- * base64-encoded data in a stream.
- *
- * @since 1.5.1
- */
- public void resumeEncoding() {
- this.suspendEncoding = false;
- } // end resumeEncoding
-
-
-
- } // end inner class OutputStream
-
-
-} // end class Base64
diff --git a/authz-client/src/main/java/org/keycloak/common/util/CollectionUtil.java b/authz-client/src/main/java/org/keycloak/common/util/CollectionUtil.java
deleted file mode 100644
index c546b05..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/CollectionUtil.java
+++ /dev/null
@@ -1,74 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.util;
-
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-import java.util.stream.Collectors;
-
-/**
- * @author Jeroen Rosenberg
- */
-public class CollectionUtil {
-
- public static String join(Collection strings) {
- return join(strings, ", ");
- }
-
- public static String join(Collection strings, String separator) {
- return strings.stream().collect(Collectors.joining(String.valueOf(separator)));
- }
-
- // Return true if all items from col1 are in col2 and viceversa. Order is not taken into account
- public static boolean collectionEquals(Collection col1, Collection col2) {
- if (col1.size()!=col2.size()) {
- return false;
- }
- Map countMap = new HashMap<>();
- for(T o : col1) {
- countMap.merge(o, 1, (v1, v2) -> v1 + v2);
- }
- for(T o : col2) {
- Integer v = countMap.get(o);
- if (v==null) {
- return false;
- }
- if (v == 1) {
- countMap.remove(o);
- } else {
- countMap.put(o, v-1);
- }
- }
- return countMap.isEmpty();
- }
-
- public static boolean isEmpty(Collection collection) {
- return collection == null || collection.isEmpty();
- }
-
- public static boolean isNotEmpty(Collection collection) {
- return !isEmpty(collection);
- }
-
- public static Set collectionToSet(Collection collection) {
- return collection == null ? null : new HashSet<>(collection);
- }
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/MultivaluedHashMap.java b/authz-client/src/main/java/org/keycloak/common/util/MultivaluedHashMap.java
deleted file mode 100755
index e2e3bb4..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/MultivaluedHashMap.java
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.util;
-
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-/**
- * @author Bill Burke
- * @version $Revision: 1 $
- */
-@SuppressWarnings("serial")
-public class MultivaluedHashMap extends HashMap> implements MultivaluedMap
-{
- public MultivaluedHashMap() {
- }
-
- public MultivaluedHashMap(Map> map) {
- if (map == null) {
- throw new IllegalArgumentException("Map can not be null");
- }
- putAll(map);
- }
-
-
- public MultivaluedHashMap(MultivaluedHashMap config) {
- addAll(config);
- }
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/MultivaluedMap.java b/authz-client/src/main/java/org/keycloak/common/util/MultivaluedMap.java
deleted file mode 100644
index 54cdfe4..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/MultivaluedMap.java
+++ /dev/null
@@ -1,93 +0,0 @@
-/*
- * Copyright 2024 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.util;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
-
-public interface MultivaluedMap extends Map> {
-
- public default void putSingle(K key, V value) {
- List list = createListInstance();
- list.add(value);
- put(key, list); // Just override with new List instance
- }
-
- public default void addAll(K key, V... newValues) {
- for (V value : newValues) {
- add(key, value);
- }
- }
-
- public default void addAll(K key, List valueList) {
- for (V value : valueList) {
- add(key, value);
- }
- }
-
- public default void addFirst(K key, V value) {
- getList(key).add(0, value);
- }
-
- public default void add(K key, V value) {
- getList(key).add(value);
- }
-
- public default void addMultiple(K key, Collection values) {
- getList(key).addAll(values);
- }
-
- public default V getFirst(K key) {
- return Optional.ofNullable(get(key)).filter(l -> !l.isEmpty()).map(l -> l.get(0)).orElse(null);
- }
-
- public default List getList(K key) {
- return compute(key, (k, v) -> v != null ? v : createListInstance());
- }
-
- public default void addAll(MultivaluedMap other) {
- for (Entry> entry : other.entrySet()) {
- getList(entry.getKey()).addAll(entry.getValue());
- }
- }
-
- public default boolean equalsIgnoreValueOrder(MultivaluedMap omap) {
- if (this == omap) {
- return true;
- }
- if (!keySet().equals(omap.keySet())) {
- return false;
- }
- for (Map.Entry> e : entrySet()) {
- List list = e.getValue();
- List olist = omap.get(e.getKey());
- if (!CollectionUtil.collectionEquals(list, olist)) {
- return false;
- }
- }
- return true;
- }
-
- public default List createListInstance() {
- return new ArrayList<>();
- }
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/ObjectUtil.java b/authz-client/src/main/java/org/keycloak/common/util/ObjectUtil.java
deleted file mode 100644
index 2dd9bab..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/ObjectUtil.java
+++ /dev/null
@@ -1,79 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.util;
-
-/**
- * @author Marek Posolda
- */
-public class ObjectUtil {
-
- private ObjectUtil() {}
-
- /**
- *
- * @param str1
- * @param str2
- * @return true if both strings are null or equal
- */
- public static boolean isEqualOrBothNull(Object str1, Object str2) {
- if (str1 == null && str2 == null) {
- return true;
- }
-
- if ((str1 != null && str2 == null) || (str1 == null && str2 != null)) {
- return false;
- }
-
- return str1.equals(str2);
- }
-
-
- public static String capitalize(String str) {
- return str.substring(0, 1).toUpperCase() + str.substring(1);
- }
-
-
- /**
- * Forked from apache-commons StringUtils
- *
- *
Checks if a CharSequence is whitespace, empty ("") or null.
- *
- * @param cs
- * @return {@code true} if the CharSequence is null, empty or whitespace
- */
- public static boolean isBlank(final CharSequence cs) {
- int strLen;
- if (cs == null || (strLen = cs.length()) == 0) {
- return true;
- }
- for (int i = 0; i < strLen; i++) {
- if (!Character.isWhitespace(cs.charAt(i))) {
- return false;
- }
- }
- return true;
- }
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/StringPropertyReplacer.java b/authz-client/src/main/java/org/keycloak/common/util/StringPropertyReplacer.java
deleted file mode 100755
index c48d022..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/StringPropertyReplacer.java
+++ /dev/null
@@ -1,282 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.keycloak.common.util;
-
-import java.io.File;
-import java.util.Properties;
-
-/**
- * A utility class for replacing properties in strings.
- *
- * @author Jason Dillon
- * @author Scott Stark
- * @author Claudio Vesco
- * @author Adrian Brock
- * @author Dimitris Andreadis
- * @version $Revision: 2898 $
- */
-public final class StringPropertyReplacer
-{
- /** New line string constant */
- public static final String NEWLINE = System.getProperty("line.separator", "\n");
-
- /** File separator value */
- private static final String FILE_SEPARATOR = File.separator;
-
- /** Path separator value */
- private static final String PATH_SEPARATOR = File.pathSeparator;
-
- /** File separator alias */
- private static final String FILE_SEPARATOR_ALIAS = "/";
-
- /** Path separator alias */
- private static final String PATH_SEPARATOR_ALIAS = ":";
-
- // States used in property parsing
- private static final int NORMAL = 0;
- private static final int SEEN_DOLLAR = 1;
- private static final int IN_BRACKET = 2;
-
- private static final Properties systemEnvProperties = new SystemEnvProperties();
-
- /**
- * Go through the input string and replace any occurrence of ${p} with
- * the System.getProperty(p) value. If there is no such property p defined,
- * then the ${p} reference will remain unchanged.
- *
- * If the property reference is of the form ${p:v} and there is no such property p,
- * then the default value v will be returned.
- *
- * If the property reference is of the form ${p1,p2} or ${p1,p2:v} then
- * the primary and the secondary properties will be tried in turn, before
- * returning either the unchanged input, or the default value.
- *
- * The property ${/} is replaced with System.getProperty("file.separator")
- * value and the property ${:} is replaced with System.getProperty("path.separator").
- *
- * @param string - the string with possible ${} references
- * @return the input string with all property references replaced if any.
- * If there are no valid references the input string will be returned.
- */
- public static String replaceProperties(final String string)
- {
- return replaceProperties(string, (Properties) null);
- }
-
- /**
- * Go through the input string and replace any occurrence of ${p} with
- * the props.getProperty(p) value. If there is no such property p defined,
- * then the ${p} reference will remain unchanged.
- *
- * If the property reference is of the form ${p:v} and there is no such property p,
- * then the default value v will be returned.
- *
- * If the property reference is of the form ${p1,p2} or ${p1,p2:v} then
- * the primary and the secondary properties will be tried in turn, before
- * returning either the unchanged input, or the default value.
- *
- * The property ${/} is replaced with System.getProperty("file.separator")
- * value and the property ${:} is replaced with System.getProperty("path.separator").
- *
- * @param string - the string with possible ${} references
- * @param props - the source for ${x} property ref values, null means use System.getProperty()
- * @return the input string with all property references replaced if any.
- * If there are no valid references the input string will be returned.
- */
- public static String replaceProperties(final String string, final Properties props) {
- if (props == null) {
- return replaceProperties(string, (PropertyResolver) null);
- }
- return replaceProperties(string, props::getProperty);
- }
-
- public static String replaceProperties(final String string, PropertyResolver resolver)
- {
- if(string == null) {
- return null;
- }
- final char[] chars = string.toCharArray();
- StringBuilder buffer = new StringBuilder();
- boolean properties = false;
- int state = NORMAL;
- int start = 0;
- int openBracketsCount = 0;
- for (int i = 0; i < chars.length; ++i)
- {
- char c = chars[i];
-
- // Dollar sign outside brackets
- if (c == '$' && state != IN_BRACKET)
- state = SEEN_DOLLAR;
-
- // Open bracket immediately after dollar
- else if (c == '{' && state == SEEN_DOLLAR)
- {
- buffer.append(string.substring(start, i - 1));
- state = IN_BRACKET;
- start = i - 1;
- openBracketsCount = 1;
- }
-
- // Seeing open bracket after we already saw some open bracket without corresponding closed bracket. This causes "nested" expressions. For example ${foo:${bar}}
- else if (c == '{' && state == IN_BRACKET)
- openBracketsCount++;
-
- // No open bracket after dollar
- else if (state == SEEN_DOLLAR)
- state = NORMAL;
-
- // Seeing closed bracket, but we already saw more than one open bracket before. Hence "nested" expression is still not fully closed.
- // For example expression ${foo:${bar}} is closed after the second closed bracket, not after the first closed bracket.
- else if (c == '}' && state == IN_BRACKET && openBracketsCount > 1)
- openBracketsCount--;
-
- // Closed bracket after open bracket
- else if (c == '}' && state == IN_BRACKET)
- {
- // No content
- if (start + 2 == i)
- {
- buffer.append("${}"); // REVIEW: Correct?
- }
- else // Collect the system property
- {
- String value = null;
-
- String key = string.substring(start + 2, i);
-
- // check for alias
- if (FILE_SEPARATOR_ALIAS.equals(key))
- {
- value = FILE_SEPARATOR;
- }
- else if (PATH_SEPARATOR_ALIAS.equals(key))
- {
- value = PATH_SEPARATOR;
- }
- else
- {
- // check from the properties
- if (resolver != null)
- value = resolver.resolve(key);
- else
- value = systemEnvProperties.getProperty(key);
-
- if (value == null)
- {
- // Check for a default value ${key:default}
- int colon = key.indexOf(':');
- if (colon > 0)
- {
- String realKey = key.substring(0, colon);
- if (resolver != null)
- value = resolver.resolve(realKey);
- else
- value = systemEnvProperties.getProperty(realKey);
-
- if (value == null)
- {
- // Check for a composite key, "key1,key2"
- value = resolveCompositeKey(realKey, resolver);
-
- // Not a composite key either, use the specified default
- if (value == null)
- value = key.substring(colon+1);
- }
- }
- else
- {
- // No default, check for a composite key, "key1,key2"
- value = resolveCompositeKey(key, resolver);
- }
- }
- }
-
- if (value != null)
- {
- properties = true;
- buffer.append(value);
- }
- else
- {
- buffer.append("${");
- buffer.append(key);
- buffer.append('}');
- }
-
- }
- start = i + 1;
- state = NORMAL;
- }
- }
-
- // No properties
- if (!properties)
- return string;
-
- // Collect the trailing characters
- if (start != chars.length)
- buffer.append(string.substring(start, chars.length));
-
- if (buffer.indexOf("${") != -1) {
- try {
- return replaceProperties(buffer.toString(), resolver);
- } catch (StackOverflowError ex) {
- throw new IllegalStateException("Infinite recursion happening when replacing properties on '" + buffer + "'");
- }
- }
-
- // Done
- return buffer.toString();
- }
-
- private static String resolveCompositeKey(String key, PropertyResolver resolver)
- {
- String value = null;
-
- // Look for the comma
- int comma = key.indexOf(',');
- if (comma > -1)
- {
- // If we have a first part, try resolve it
- if (comma > 0)
- {
- // Check the first part
- String key1 = key.substring(0, comma);
- if (resolver != null)
- value = resolver.resolve(key1);
- else
- value = systemEnvProperties.getProperty(key1);
- }
- // Check the second part, if there is one and first lookup failed
- if (value == null && comma < key.length() - 1)
- {
- String key2 = key.substring(comma + 1);
- if (resolver != null)
- value = resolver.resolve(key2);
- else
- value = systemEnvProperties.getProperty(key2);
- }
- }
- // Return whatever we've found or null
- return value;
- }
-
- public interface PropertyResolver {
- String resolve(String property);
- }
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/SystemEnvProperties.java b/authz-client/src/main/java/org/keycloak/common/util/SystemEnvProperties.java
deleted file mode 100644
index 78fc4c7..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/SystemEnvProperties.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.util;
-
-import java.util.Collections;
-import java.util.Map;
-import java.util.Properties;
-
-/**
- * @author Stian Thorgersen
- */
-public class SystemEnvProperties extends Properties {
-
- private final Map overrides;
-
- public SystemEnvProperties(Map overrides) {
- this.overrides = overrides;
- }
-
- public SystemEnvProperties() {
- this.overrides = Collections.EMPTY_MAP;
- }
-
- @Override
- public String getProperty(String key) {
- if (overrides.containsKey(key)) {
- return overrides.get(key);
- } else if (key.startsWith("env.")) {
- return System.getenv().get(key.substring(4));
- } else {
- return System.getProperty(key);
- }
- }
-
- @Override
- public String getProperty(String key, String defaultValue) {
- String value = getProperty(key);
- return value != null ? value : defaultValue;
- }
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/common/util/Time.java b/authz-client/src/main/java/org/keycloak/common/util/Time.java
deleted file mode 100644
index ef4187c..0000000
--- a/authz-client/src/main/java/org/keycloak/common/util/Time.java
+++ /dev/null
@@ -1,87 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.common.util;
-
-import java.util.Date;
-
-/**
- * @author Stian Thorgersen
- */
-public class Time {
-
- private static volatile int offset;
-
- /**
- * Returns current time in seconds adjusted by adding {@link #offset) seconds.
- * @return see description
- */
- public static int currentTime() {
- return ((int) (System.currentTimeMillis() / 1000)) + offset;
- }
-
- /**
- * Returns current time in milliseconds adjusted by adding {@link #offset) seconds.
- * @return see description
- */
- public static long currentTimeMillis() {
- return System.currentTimeMillis() + (offset * 1000L);
- }
-
- /**
- * Returns {@link Date} object, its value set to time
- * @param time Time in milliseconds since the epoch
- * @return see description
- */
- public static Date toDate(int time) {
- return new Date(time * 1000L);
- }
-
- /**
- * Returns {@link Date} object, its value set to time
- * @param time Time in milliseconds since the epoch
- * @return see description
- */
- public static Date toDate(long time) {
- return new Date(time);
- }
-
- /**
- * Returns time in milliseconds for a time in seconds. No adjustment is made to the parameter.
- * @param time Time in seconds since the epoch
- * @return Time in milliseconds
- */
- public static long toMillis(long time) {
- return time * 1000L;
- }
-
- /**
- * @return Time offset in seconds that will be added to {@link #currentTime()} and {@link #currentTimeMillis()}.
- */
- public static int getOffset() {
- return offset;
- }
-
- /**
- * Sets time offset in seconds that will be added to {@link #currentTime()} and {@link #currentTimeMillis()}.
- * @param offset Offset (in seconds)
- */
- public static void setOffset(int offset) {
- Time.offset = offset;
- }
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/crypto/Algorithm.java b/authz-client/src/main/java/org/keycloak/crypto/Algorithm.java
deleted file mode 100755
index ab6efb6..0000000
--- a/authz-client/src/main/java/org/keycloak/crypto/Algorithm.java
+++ /dev/null
@@ -1,57 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.keycloak.crypto;
-
-import org.keycloak.common.crypto.CryptoConstants;
-
-public interface Algorithm {
-
- /* RSA signing algorithms */
- String HS256 = "HS256";
- String HS384 = "HS384";
- String HS512 = "HS512";
- String RS256 = "RS256";
- String RS384 = "RS384";
- String RS512 = "RS512";
- String PS256 = "PS256";
- String PS384 = "PS384";
- String PS512 = "PS512";
-
- /* ECDSA signing algorithms */
- String ES256 = "ES256";
- String ES384 = "ES384";
- String ES512 = "ES512";
-
- /* EdDSA signing algorithms */
- String EdDSA = "EdDSA";
- /* EdDSA Curve */
- String Ed25519 = "Ed25519";
- String Ed448 = "Ed448";
-
- /* RSA Encryption Algorithms */
- String RSA1_5 = CryptoConstants.RSA1_5;
- String RSA_OAEP = CryptoConstants.RSA_OAEP;
- String RSA_OAEP_256 = CryptoConstants.RSA_OAEP_256;
-
- /* AES */
- String AES = "AES";
-
- String ECDH_ES = CryptoConstants.ECDH_ES;
- String ECDH_ES_A128KW = CryptoConstants.ECDH_ES_A128KW;
- String ECDH_ES_A192KW = CryptoConstants.ECDH_ES_A192KW;
- String ECDH_ES_A256KW = CryptoConstants.ECDH_ES_A256KW;
-}
diff --git a/authz-client/src/main/java/org/keycloak/crypto/KeyUse.java b/authz-client/src/main/java/org/keycloak/crypto/KeyUse.java
deleted file mode 100644
index ddf6d06..0000000
--- a/authz-client/src/main/java/org/keycloak/crypto/KeyUse.java
+++ /dev/null
@@ -1,34 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.keycloak.crypto;
-
-public enum KeyUse {
-
- SIG("sig"),
- ENC("enc");
-
- private String specName;
-
- KeyUse(String specName) {
- this.specName = specName;
- }
-
- public String getSpecName() {
- return specName;
- }
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/jose/jwk/JWKBuilder.java b/authz-client/src/main/java/org/keycloak/jose/jwk/JWKBuilder.java
deleted file mode 100644
index 282dbd3..0000000
--- a/authz-client/src/main/java/org/keycloak/jose/jwk/JWKBuilder.java
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.jose.jwk;
-
-import org.keycloak.crypto.KeyUse;
-
-import java.security.Key;
-
-/**
- * @author Stian Thorgersen
- */
-public class JWKBuilder extends AbstractJWKBuilder {
-
- public static JWKBuilder create() {
- return new JWKBuilder();
- }
-
- public JWKBuilder kid(String kid) {
- this.kid = kid;
- return this;
- }
-
- public JWKBuilder algorithm(String algorithm) {
- this.algorithm = algorithm;
- return this;
- }
-
- @Override
- public JWK okp(Key key) {
- // not supported if jdk vesion < 17
- throw new UnsupportedOperationException("EdDSA algorithms not supported in this JDK version");
- }
-
- @Override
- public JWK okp(Key key, KeyUse keyUse) {
- // not supported if jdk version < 17
- throw new UnsupportedOperationException("EdDSA algorithms not supported in this JDK version");
- }
-}
diff --git a/authz-client/src/main/java/org/keycloak/jose/jwk/JWKParser.java b/authz-client/src/main/java/org/keycloak/jose/jwk/JWKParser.java
deleted file mode 100755
index 13820e3..0000000
--- a/authz-client/src/main/java/org/keycloak/jose/jwk/JWKParser.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.jose.jwk;
-
-import org.keycloak.util.JsonSerialization;
-
-/**
- * @author Stian Thorgersen
- */
-public class JWKParser extends AbstractJWKParser {
-
- protected JWKParser() {
- }
-
- public JWKParser(JWK jwk) {
- this.jwk = jwk;
- }
-
- public static JWKParser create() {
- return new JWKParser();
- }
-
- public static JWKParser create(JWK jwk) {
- return new JWKParser(jwk);
- }
-
- public JWKParser parse(String jwk) {
- try {
- this.jwk = JsonSerialization.mapper.readValue(jwk, JWK.class);
- return this;
- } catch (Exception e) {
- throw new RuntimeException(e);
- }
- }
-
-}
diff --git a/authz-client/src/main/java/org/keycloak/json/StringListMapDeserializer.java b/authz-client/src/main/java/org/keycloak/json/StringListMapDeserializer.java
deleted file mode 100644
index 1241fd0..0000000
--- a/authz-client/src/main/java/org/keycloak/json/StringListMapDeserializer.java
+++ /dev/null
@@ -1,58 +0,0 @@
-/*
- * Copyright 2016 Red Hat, Inc. and/or its affiliates
- * and other contributors as indicated by the @author tags.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.keycloak.json;
-
-import com.fasterxml.jackson.core.JsonParser;
-import com.fasterxml.jackson.databind.DeserializationContext;
-import com.fasterxml.jackson.databind.JsonDeserializer;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.node.ArrayNode;
-
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Map;
-
-public class StringListMapDeserializer extends JsonDeserializer