keycloakify 9.0.0-rc.1 → 9.0.0

package/bin/keycloakify/generateJavaStackFiles/account-v1-java/services/resources/account/AccountFormServiceFactory.java

@@ -1,64 +0,0 @@
-package org.keycloak.services.resources.account;
-
-import com.google.auto.service.AutoService;
-import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.ImmutableSet;
-import java.util.Map;
-import lombok.extern.jbosslog.JBossLog;
-import org.keycloak.Config.Scope;
-import org.keycloak.events.EventBuilder;
-import org.keycloak.models.ClientModel;
-import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.KeycloakSessionFactory;
-import org.keycloak.models.ProtocolMapperModel;
-import org.keycloak.models.RealmModel;
-import org.keycloak.provider.ProviderEvent;
-import org.keycloak.services.resource.AccountResourceProvider;
-import org.keycloak.services.resource.AccountResourceProviderFactory;
-import jakarta.ws.rs.NotFoundException;
-import org.keycloak.models.Constants;
-
-@JBossLog
-@AutoService(AccountResourceProviderFactory.class)
-public class AccountFormServiceFactory implements AccountResourceProviderFactory {
-
-  public static final String ID = "account-v1";
-
-  @Override
-  public String getId() {
-    return ID;
-  }
-
-  private ClientModel getAccountManagementClient(RealmModel realm) {
-    ClientModel client = realm.getClientByClientId(Constants.ACCOUNT_MANAGEMENT_CLIENT_ID);
-    if (client == null || !client.isEnabled()) {
-      log.debug("account management not enabled");
-      throw new NotFoundException("account management not enabled");
-    }
-    return client;
-  }
-
-  @Override
-  public AccountResourceProvider create(KeycloakSession session) {
-    log.info("create");
-    RealmModel realm = session.getContext().getRealm();
-    ClientModel client = getAccountManagementClient(realm);
-    EventBuilder event = new EventBuilder​(realm, session, session.getContext().getConnection());
-    return new AccountFormService(session, client, event);
-  }
-
-  @Override
-  public void init(Scope config) {
-    log.info("init");
-  }
-
-  @Override
-  public void postInit(KeycloakSessionFactory factory) {
-    log.info("postInit");
-  }
-
-  @Override
-  public void close() {
-    log.info("close");
-  }
-}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountPages.java

@@ -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.forms.account;
-
-/**
- * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
- */
-public enum AccountPages {
-  ACCOUNT,
-  PASSWORD,
-  TOTP,
-  FEDERATED_IDENTITY,
-  LOG,
-  SESSIONS,
-  APPLICATIONS,
-  RESOURCES,
-  RESOURCE_DETAIL;
-}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountProvider.java

@@ -1,76 +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.forms.account;
-
-import jakarta.ws.rs.core.HttpHeaders;
-import jakarta.ws.rs.core.MultivaluedMap;
-import jakarta.ws.rs.core.Response;
-import jakarta.ws.rs.core.UriInfo;
-import java.util.List;
-import org.keycloak.events.Event;
-import org.keycloak.models.RealmModel;
-import org.keycloak.models.UserModel;
-import org.keycloak.models.UserSessionModel;
-import org.keycloak.models.utils.FormMessage;
-import org.keycloak.provider.Provider;
-
-/**
- * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
- */
-public interface AccountProvider extends Provider {
-
-  AccountProvider setUriInfo(UriInfo uriInfo);
-
-  AccountProvider setHttpHeaders(HttpHeaders httpHeaders);
-
-  Response createResponse(AccountPages page);
-
-  AccountProvider setError(Response.Status status, String message, Object... parameters);
-
-  AccountProvider setErrors(Response.Status status, List<FormMessage> messages);
-
-  AccountProvider setSuccess(String message, Object... parameters);
-
-  AccountProvider setWarning(String message, Object... parameters);
-
-  AccountProvider setUser(UserModel user);
-
-  AccountProvider setProfileFormData(MultivaluedMap<String, String> formData);
-
-  AccountProvider setRealm(RealmModel realm);
-
-  AccountProvider setReferrer(String[] referrer);
-
-  AccountProvider setEvents(List<Event> events);
-
-  AccountProvider setSessions(List<UserSessionModel> sessions);
-
-  AccountProvider setPasswordSet(boolean passwordSet);
-
-  AccountProvider setStateChecker(String stateChecker);
-
-  AccountProvider setIdTokenHint(String idTokenHint);
-
-  AccountProvider setFeatures(
-      boolean social,
-      boolean events,
-      boolean passwordUpdateSupported,
-      boolean authorizationSupported);
-
-  AccountProvider setAttribute(String key, String value);
-}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountProviderFactory.java

@@ -1,25 +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.forms.account;
-
-import org.keycloak.provider.ProviderFactory;
-
-/**
- * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
- */
-public interface AccountProviderFactory extends ProviderFactory<AccountProvider> {}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountSpi.java

@@ -1,50 +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.forms.account;
-
-import com.google.auto.service.AutoService;
-import org.keycloak.provider.Provider;
-import org.keycloak.provider.ProviderFactory;
-import org.keycloak.provider.Spi;
-
-/**
- * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
- */
-@AutoService(Spi.class)
-public class AccountSpi implements Spi {
-
-  @Override
-  public boolean isInternal() {
-    return true;
-  }
-
-  @Override
-  public String getName() {
-    return "account";
-  }
-
-  @Override
-  public Class<? extends Provider> getProviderClass() {
-    return AccountProvider.class;
-  }
-
-  @Override
-  public Class<? extends ProviderFactory> getProviderFactoryClass() {
-    return AccountProviderFactory.class;
-  }
-}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/freemarker/FreeMarkerAccountProvider.java

@@ -1,424 +0,0 @@
-/*
- * Copyright 2022 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.forms.account.freemarker;
-
-import jakarta.ws.rs.core.HttpHeaders;
-import jakarta.ws.rs.core.MultivaluedMap;
-import jakarta.ws.rs.core.Response;
-import jakarta.ws.rs.core.Response.Status;
-import jakarta.ws.rs.core.UriBuilder;
-import jakarta.ws.rs.core.UriInfo;
-import java.io.IOException;
-import java.net.URI;
-import java.text.MessageFormat;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Properties;
-import org.jboss.logging.Logger;
-import org.keycloak.events.Event;
-import org.keycloak.forms.account.AccountPages;
-import org.keycloak.forms.account.AccountProvider;
-import org.keycloak.forms.account.freemarker.model.AccountBean;
-import org.keycloak.forms.account.freemarker.model.AccountFederatedIdentityBean;
-import org.keycloak.forms.account.freemarker.model.ApplicationsBean;
-import org.keycloak.forms.account.freemarker.model.AuthorizationBean;
-import org.keycloak.forms.account.freemarker.model.FeaturesBean;
-import org.keycloak.forms.account.freemarker.model.LogBean;
-import org.keycloak.forms.account.freemarker.model.PasswordBean;
-import org.keycloak.forms.account.freemarker.model.RealmBean;
-import org.keycloak.forms.account.freemarker.model.ReferrerBean;
-import org.keycloak.forms.account.freemarker.model.SessionsBean;
-import org.keycloak.forms.account.freemarker.model.TotpBean;
-import org.keycloak.forms.account.freemarker.model.UrlBean;
-import org.keycloak.forms.login.MessageType;
-import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
-import org.keycloak.models.UserModel;
-import org.keycloak.models.UserSessionModel;
-import org.keycloak.models.utils.FormMessage;
-import org.keycloak.services.util.CacheControlUtil;
-import org.keycloak.theme.FreeMarkerException;
-import org.keycloak.theme.Theme;
-import org.keycloak.theme.beans.AdvancedMessageFormatterMethod;
-import org.keycloak.theme.beans.LocaleBean;
-import org.keycloak.theme.beans.MessageBean;
-import org.keycloak.theme.beans.MessageFormatterMethod;
-import org.keycloak.theme.beans.MessagesPerFieldBean;
-import org.keycloak.theme.freemarker.FreeMarkerProvider;
-import org.keycloak.utils.MediaType;
-import org.keycloak.utils.StringUtil;
-
-/**
- * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
- */
-public class FreeMarkerAccountProvider implements AccountProvider {
-
-  private static final Logger logger = Logger.getLogger(FreeMarkerAccountProvider.class);
-
-  protected UserModel user;
-  protected MultivaluedMap<String, String> profileFormData;
-  protected Response.Status status = Response.Status.OK;
-  protected RealmModel realm;
-  protected String[] referrer;
-  protected List<Event> events;
-  protected String stateChecker;
-  protected String idTokenHint;
-  protected List<UserSessionModel> sessions;
-  protected boolean identityProviderEnabled;
-  protected boolean eventsEnabled;
-  protected boolean passwordUpdateSupported;
-  protected boolean passwordSet;
-  protected KeycloakSession session;
-  protected FreeMarkerProvider freeMarker;
-  protected HttpHeaders headers;
-  protected Map<String, Object> attributes;
-
-  protected UriInfo uriInfo;
-
-  protected List<FormMessage> messages = null;
-  protected MessageType messageType = MessageType.ERROR;
-  private boolean authorizationSupported;
-
-  public FreeMarkerAccountProvider(KeycloakSession session) {
-    this.session = session;
-    this.freeMarker = session.getProvider(FreeMarkerProvider.class);
-  }
-
-  public AccountProvider setUriInfo(UriInfo uriInfo) {
-    this.uriInfo = uriInfo;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setHttpHeaders(HttpHeaders httpHeaders) {
-    this.headers = httpHeaders;
-    return this;
-  }
-
-  @Override
-  public Response createResponse(AccountPages page) {
-    Map<String, Object> attributes = new HashMap<>();
-
-    if (this.attributes != null) {
-      attributes.putAll(this.attributes);
-    }
-
-    Theme theme;
-    try {
-      theme = getTheme();
-    } catch (IOException e) {
-      logger.error("Failed to create theme", e);
-      return Response.serverError().build();
-    }
-
-    Locale locale = session.getContext().resolveLocale(user);
-    Properties messagesBundle = handleThemeResources(theme, locale, attributes);
-
-    URI baseUri = uriInfo.getBaseUri();
-    UriBuilder baseUriBuilder = uriInfo.getBaseUriBuilder();
-    for (Map.Entry<String, List<String>> e : uriInfo.getQueryParameters().entrySet()) {
-      baseUriBuilder.queryParam(e.getKey(), e.getValue().toArray());
-    }
-    URI baseQueryUri = baseUriBuilder.build();
-
-    if (stateChecker != null) {
-      attributes.put("stateChecker", stateChecker);
-    }
-
-    handleMessages(locale, messagesBundle, attributes);
-
-    if (referrer != null) {
-      attributes.put("referrer", new ReferrerBean(referrer));
-    }
-
-    if (realm != null) {
-      attributes.put("realm", new RealmBean(realm));
-    }
-
-    attributes.put(
-        "url",
-        new UrlBean(realm, theme, baseUri, baseQueryUri, uriInfo.getRequestUri(), idTokenHint));
-
-    if (realm.isInternationalizationEnabled()) {
-      UriBuilder b = UriBuilder.fromUri(baseQueryUri).path(uriInfo.getPath());
-      attributes.put("locale", new LocaleBean(realm, locale, b, messagesBundle));
-    }
-
-    attributes.put(
-        "features",
-        new FeaturesBean(
-            identityProviderEnabled,
-            eventsEnabled,
-            passwordUpdateSupported,
-            authorizationSupported));
-    attributes.put("account", new AccountBean(user, profileFormData));
-
-    switch (page) {
-      case TOTP:
-        attributes.put("totp", new TotpBean(session, realm, user, uriInfo.getRequestUriBuilder()));
-        break;
-      case FEDERATED_IDENTITY:
-        attributes.put(
-            "federatedIdentity",
-            new AccountFederatedIdentityBean(
-                session, realm, user, uriInfo.getBaseUri(), stateChecker));
-        break;
-      case LOG:
-        attributes.put("log", new LogBean(events));
-        break;
-      case SESSIONS:
-        attributes.put("sessions", new SessionsBean(realm, sessions));
-        break;
-      case APPLICATIONS:
-        attributes.put("applications", new ApplicationsBean(session, realm, user));
-        attributes.put("advancedMsg", new AdvancedMessageFormatterMethod(locale, messagesBundle));
-        break;
-      case PASSWORD:
-        attributes.put("password", new PasswordBean(passwordSet));
-        break;
-      case RESOURCES:
-        if (!realm.isUserManagedAccessAllowed()) {
-          return Response.status(Status.FORBIDDEN).build();
-        }
-        attributes.put("authorization", new AuthorizationBean(session, realm, user, uriInfo));
-      case RESOURCE_DETAIL:
-        if (!realm.isUserManagedAccessAllowed()) {
-          return Response.status(Status.FORBIDDEN).build();
-        }
-        attributes.put("authorization", new AuthorizationBean(session, realm, user, uriInfo));
-    }
-
-    return processTemplate(theme, page, attributes, locale);
-  }
-
-  /**
-   * Get Theme used for page rendering.
-   *
-   * @return theme for page rendering, never null
-   * @throws IOException in case of Theme loading problem
-   */
-  protected Theme getTheme() throws IOException {
-    return session.theme().getTheme(Theme.Type.ACCOUNT);
-  }
-
-  /**
-   * Load message bundle and place it into <code>msg</code> template attribute. Also load Theme
-   * properties and place them into <code>properties</code> template attribute.
-   *
-   * @param theme actual Theme to load bundle from
-   * @param locale to load bundle for
-   * @param attributes template attributes to add resources to
-   * @return message bundle for other use
-   */
-  protected Properties handleThemeResources(
-      Theme theme, Locale locale, Map<String, Object> attributes) {
-    Properties messagesBundle = new Properties();
-    try {
-      if (!StringUtil.isNotBlank(realm.getDefaultLocale())) {
-        messagesBundle.putAll(realm.getRealmLocalizationTextsByLocale(realm.getDefaultLocale()));
-      }
-      messagesBundle.putAll(theme.getMessages(locale));
-      messagesBundle.putAll(realm.getRealmLocalizationTextsByLocale(locale.toLanguageTag()));
-      attributes.put("msg", new MessageFormatterMethod(locale, messagesBundle));
-    } catch (IOException e) {
-      logger.warn("Failed to load messages", e);
-      messagesBundle = new Properties();
-    }
-    try {
-      attributes.put("properties", theme.getProperties());
-    } catch (IOException e) {
-      logger.warn("Failed to load properties", e);
-    }
-    return messagesBundle;
-  }
-
-  /**
-   * Handle messages to be shown on the page - set them to template attributes
-   *
-   * @param locale to be used for message text loading
-   * @param messagesBundle to be used for message text loading
-   * @param attributes template attributes to messages related info to
-   * @see #messageType
-   * @see #messages
-   */
-  protected void handleMessages(
-      Locale locale, Properties messagesBundle, Map<String, Object> attributes) {
-    MessagesPerFieldBean messagesPerField = new MessagesPerFieldBean();
-    if (messages != null) {
-      MessageBean wholeMessage = new MessageBean(null, messageType);
-      for (FormMessage message : this.messages) {
-        String formattedMessageText = formatMessage(message, messagesBundle, locale);
-        if (formattedMessageText != null) {
-          wholeMessage.appendSummaryLine(formattedMessageText);
-          messagesPerField.addMessage(message.getField(), formattedMessageText, messageType);
-        }
-      }
-      attributes.put("message", wholeMessage);
-    }
-    attributes.put("messagesPerField", messagesPerField);
-  }
-
-  /**
-   * Process FreeMarker template and prepare Response. Some fields are used for rendering also.
-   *
-   * @param theme to be used (provided by <code>getTheme()</code>)
-   * @param page to be rendered
-   * @param attributes pushed to the template
-   * @param locale to be used
-   * @return Response object to be returned to the browser, never null
-   */
-  protected Response processTemplate(
-      Theme theme, AccountPages page, Map<String, Object> attributes, Locale locale) {
-    try {
-      String result = freeMarker.processTemplate(attributes, Templates.getTemplate(page), theme);
-      Response.ResponseBuilder builder =
-          Response.status(status)
-              .type(MediaType.TEXT_HTML_UTF_8_TYPE)
-              .language(locale)
-              .entity(result);
-      builder.cacheControl(CacheControlUtil.noCache());
-      return builder.build();
-    } catch (FreeMarkerException e) {
-      logger.error("Failed to process template", e);
-      return Response.serverError().build();
-    }
-  }
-
-  public AccountProvider setPasswordSet(boolean passwordSet) {
-    this.passwordSet = passwordSet;
-    return this;
-  }
-
-  protected void setMessage(MessageType type, String message, Object... parameters) {
-    messageType = type;
-    messages = new ArrayList<>();
-    messages.add(new FormMessage(null, message, parameters));
-  }
-
-  protected String formatMessage(FormMessage message, Properties messagesBundle, Locale locale) {
-    if (message == null) return null;
-    if (messagesBundle.containsKey(message.getMessage())) {
-      return new MessageFormat(messagesBundle.getProperty(message.getMessage()), locale)
-          .format(message.getParameters());
-    } else {
-      return message.getMessage();
-    }
-  }
-
-  @Override
-  public AccountProvider setErrors(Response.Status status, List<FormMessage> messages) {
-    this.status = status;
-    this.messageType = MessageType.ERROR;
-    this.messages = new ArrayList<>(messages);
-    return this;
-  }
-
-  @Override
-  public AccountProvider setError(Response.Status status, String message, Object... parameters) {
-    this.status = status;
-    setMessage(MessageType.ERROR, message, parameters);
-    return this;
-  }
-
-  @Override
-  public AccountProvider setSuccess(String message, Object... parameters) {
-    setMessage(MessageType.SUCCESS, message, parameters);
-    return this;
-  }
-
-  @Override
-  public AccountProvider setWarning(String message, Object... parameters) {
-    setMessage(MessageType.WARNING, message, parameters);
-    return this;
-  }
-
-  @Override
-  public AccountProvider setUser(UserModel user) {
-    this.user = user;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setProfileFormData(MultivaluedMap<String, String> formData) {
-    this.profileFormData = formData;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setRealm(RealmModel realm) {
-    this.realm = realm;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setReferrer(String[] referrer) {
-    this.referrer = referrer;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setEvents(List<Event> events) {
-    this.events = events;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setSessions(List<UserSessionModel> sessions) {
-    this.sessions = sessions;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setStateChecker(String stateChecker) {
-    this.stateChecker = stateChecker;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setIdTokenHint(String idTokenHint) {
-    this.idTokenHint = idTokenHint;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setFeatures(
-      boolean identityProviderEnabled,
-      boolean eventsEnabled,
-      boolean passwordUpdateSupported,
-      boolean authorizationSupported) {
-    this.identityProviderEnabled = identityProviderEnabled;
-    this.eventsEnabled = eventsEnabled;
-    this.passwordUpdateSupported = passwordUpdateSupported;
-    this.authorizationSupported = authorizationSupported;
-    return this;
-  }
-
-  @Override
-  public AccountProvider setAttribute(String key, String value) {
-    if (attributes == null) {
-      attributes = new HashMap<>();
-    }
-    attributes.put(key, value);
-    return this;
-  }
-
-  @Override
-  public void close() {}
-}