@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/hidden/senselogic/sitevision/api/security/MessageDigester/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Message digester that performs hash computation using a specific algorithm.
+ *
+ * <p>
+ *    Message digests are secure one-way hash functions that take arbitrary-sized
+ *    data and output a fixed-length hash value.
+ *
+ *    Implementations of this interface is typically backed by a <code>java.security.MessageDigest</code>
+ *    instance for given algorithm.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface for a specific algorithm can be obtained
+ *    via {@link senselogic.sitevision.api.security.MessageDigesterFactory}.
+ * </p>Updates the digest with a byte.Updates the digest with an array of bytes.Executes the hash computation.
+ *
+ * The digest is reset after this call is made.Returns a string that identifies the algorithm.
+ * @author Magnus Lövgren
+ * @since Sitevision 5.0.1
+ * @see MessageDigesterFactory
+ */
+interface MessageDigester {
+  /**
+   * Updates the digest with a byte.
+   * @param aByte the byte.
+   */
+  updateByte(aByte: unknown): void;
+
+  /**
+   * Updates the digest with an array of bytes.
+   * @param aBytes the array of bytes.
+   */
+  updateBytes(aBytes: unknown): void;
+
+  /**
+   * Executes the hash computation.
+   *
+   * The digest is reset after this call is made.
+   * @return the array of bytes for the resulting hash value.
+   */
+  digest(): unknown;
+
+  /**
+   * Returns a string that identifies the algorithm.
+   * @return the hash algorithm
+   */
+  getAlgorithm(): string;
+}
+
+export default MessageDigester;

package/hidden/senselogic/sitevision/api/security/RoleAssignment/index.d.ts

@@ -0,0 +1,72 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Role assignment representation that can be applied on a node to update its roles setup.
+ *
+ * <p>
+ *    A role assignment instance is a representation of a <em>sv:role</em> and a
+ *    <em>principal (sv:user, sv:simpleUser, sv:userGroup or sv:virtualGroup)</em>
+ *    that can be applied to various nodes using the {@link #apply(Node)} method.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link RoleAssignmentBuilder#build()}.
+ *    See {@link RoleAssignmentBuilder} for how to obtain an instance of the <code>RoleAssignmentBuilder</code> interface.
+ * </p>Applies this role assignment on a given node.Whether or not current user is allowed to {@link #apply(Node)} or {@link #revoke(Node)} this role assignment for a given node.
+ *
+ * <p>
+ *    <em>Permission note!</em> Current user must have {@link PermissionUtil.Permission#MANAGE_RIGHTS} on aNode
+ *    and current user must also have the role (that this role assignment contains) on aNode.
+ * </p>Whether or not a given node already has this role assignment applied.
+ *
+ * <p>
+ *    <em>Note! If this method returns true, there is no need to execute {@link #apply(Node)}.</em>
+ * </p>Revokes this role assignment on a given node.
+ * @author Magnus Lövgren
+ * @since Sitevision 5.1
+ */
+interface RoleAssignment {
+  /**
+   * Applies this role assignment on a given node.
+   * @param aNode the node of the role assignment operation, typically a sv:page
+   * @throws ConstraintViolationException if current user doesn't have permission to do the role assignment on aNode
+   * @throws RepositoryException if something else goes wrong (e.g. mutation might fail if no lock can be acquired for aNode)
+   * @see #isApplicable(Node)
+   */
+  apply(aNode: Node): void;
+
+  /**
+   * Whether or not current user is allowed to {@link #apply(Node)} or {@link #revoke(Node)} this role assignment for a given node.
+   *
+   * <p>
+   *    <em>Permission note!</em> Current user must have {@link PermissionUtil.Permission#MANAGE_RIGHTS} on aNode
+   *    and current user must also have the role (that this role assignment contains) on aNode.
+   * </p>
+   * @param aNode the node of the role assignment operation, typically a sv:page
+   * @return true if current user is allowed to apply/revoke this role assignment on aNode, false otherwise
+   */
+  isApplicable(aNode: Node): boolean;
+
+  /**
+   * Whether or not a given node already has this role assignment applied.
+   *
+   * <p>
+   *    <em>Note! If this method returns true, there is no need to execute {@link #apply(Node)}.</em>
+   * </p>
+   * @param aNode the node of the role assignment operation, typically a sv:page
+   * @return true if aNode already has this role assignment, false otherwise
+   */
+  isApplied(aNode: Node): boolean;
+
+  /**
+   * Revokes this role assignment on a given node.
+   * @param aNode the node of the revoke operation, typically a sv:page
+   * @throws ConstraintViolationException if current user doesn't have permission to revoke the role assignment on aNode
+   * @throws RepositoryException if something else goes wrong (e.g. mutation might fail if no lock can be acquired for aNode)
+   * @see #isApplicable(Node)
+   * @since Sitevision 6.0.1
+   */
+  revoke(aNode: Node): void;
+}
+
+export default RoleAssignment;

package/hidden/senselogic/sitevision/api/security/RoleMatcher/index.d.ts

@@ -0,0 +1,29 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Role matcher representation that can be matched on a node to check "is user in role".
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link RoleMatcherBuilder#build()}.
+ *    See {@link RoleMatcherBuilder} for how to obtain an instance of the <code>RoleMatcherBuilder</code> interface.
+ * </p>Checks if matcher user is in all matcher roles on a given Node.Checks if matcher user is in any matcher role on a given Node.
+ * @author Magnus Lövgren
+ * @since Sitevision 6.1
+ */
+interface RoleMatcher {
+  /**
+   * Checks if matcher user is in all matcher roles on a given Node.
+   * @param aNode the node, typically a sv:page
+   * @return true if matcher "user is in role" for all of the matcher roles on aNode, false otherwise
+   */
+  matchesAll(aNode: Node): boolean;
+
+  /**
+   * Checks if matcher user is in any matcher role on a given Node.
+   * @param aNode the node, typically a sv:page
+   * @return true if matcher "user is in role" for any of the matcher roles on aNode, false otherwise
+   */
+  matchesAny(aNode: Node): boolean;
+}
+
+export default RoleMatcher;

package/hidden/senselogic/sitevision/api/security/SecretStore/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Interface to "Secret store".
+ *
+ * <p>
+ *    The store contains secrets about the current user, which are encrypted, typically by using the password of the user.
+ * </p>
+ *
+ * <p>
+ *    The secret store can be accessed by casting the user object to this interface. The user object can be
+ *    accessed through the Portlet API (request.getUserPrincipal()) or by using the principal in the Subject through JAAS.
+ * </p>Sets a secret for a specified key.Gets a secret for a specified key.Removes a secret for a specified key.Gets all secrets.Sets a map of secrets.
+ * @author Rickard Öberg
+ * @see Secret
+ */
+interface SecretStore {
+  /**
+   * Sets a secret for a specified key.
+   * @param aKey the identifier for secret
+   * @param aSecret the secret
+   */
+  setSecret(aKey: unknown, aSecret: unknown): void;
+
+  /**
+   * Gets a secret for a specified key.
+   * @param aKey the identifier for a secret
+   * @return a secret
+   */
+  getSecret(aKey: unknown): unknown;
+
+  /**
+   * Removes a secret for a specified key.
+   * @param aKey the identifier for a secret
+   */
+  removeSecret(aKey: unknown): void;
+
+  /**
+   * Gets all secrets.
+   * @return a map of secrets
+   */
+  getSecrets(): Record<unknown, unknown>;
+
+  /**
+   * Sets a map of secrets.
+   * @param aSecrets the secrets
+   */
+  setSecrets(aSecrets: Record<unknown, unknown>): void;
+
+  /**
+ * 
+  
+    */
+  removeAllSecrets(): void;
+}
+
+export default SecretStore;

package/hidden/senselogic/sitevision/api/security/UserUtil/index.d.ts

@@ -0,0 +1,80 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Deprecated interface that will be removed in a future Sitevision release.Checks if current user is anonymous (not authenticated).Checks if a user node is anonymous (not authenticated).Checks if current user is the Sitevision System user.Checks if a user node is the Sitevision System user.Checks if current user is the Sitevision Indexer.Checks if a user node is the Sitevision Indexer.Checks if current user is the Sitevision Extractor.Checks if a user node is the Sitevision Extractor.Gets the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0
+ * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil} and {@link senselogic.sitevision.api.user.UserIdentityUtil} instead
+ */
+interface UserUtil {
+  /**
+   * Checks if current user is anonymous (not authenticated).
+   * @return <code>true</code> if current user is Anonymous (i.e. not authenticated), <code>false</code> otherwise
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isAnonymous()} instead
+   */
+  isAnonymous(): boolean;
+
+  /**
+   * Checks if a user node is anonymous (not authenticated).
+   * @param aUserNode a user node
+   * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isAnonymous(javax.jcr.Node)} instead
+   */
+  isAnonymous(aUserNode: Node): boolean;
+
+  /**
+   * Checks if current user is the Sitevision System user.
+   * @return <code>true</code> if current user is the Sitevision System user, <code>false</code> otherwise
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isSystem()} instead
+   */
+  isSystem(): boolean;
+
+  /**
+   * Checks if a user node is the Sitevision System user.
+   * @param aUserNode a user node
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isSystem(javax.jcr.Node)} instead
+   */
+  isSystem(aUserNode: Node): boolean;
+
+  /**
+   * Checks if current user is the Sitevision Indexer.
+   * @return <code>true</code> if current user is the Sitevision Indexer, <code>false</code> otherwise
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isIndexer()} instead
+   */
+  isIndexer(): boolean;
+
+  /**
+   * Checks if a user node is the Sitevision Indexer.
+   * @param aUserNode a user node
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isIndexer(javax.jcr.Node)} instead
+   */
+  isIndexer(aUserNode: Node): boolean;
+
+  /**
+   * Checks if current user is the Sitevision Extractor.
+   * @return <code>true</code> if current user is the Sitevision Extractor, <code>false</code> otherwise
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isExtractor()} instead
+   */
+  isExtractor(): boolean;
+
+  /**
+   * Checks if a user node is the Sitevision Extractor.
+   * @param aUserNode a user node
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isExtractor(javax.jcr.Node)} instead
+   */
+  isExtractor(aUserNode: Node): boolean;
+
+  /**
+   * Gets the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
+   * @param aUserNode a user node
+   * @return the corresponding sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or has no corresponding user identity for current site.
+   * @since Sitevision 3.5.1
+   * @deprecated use {@link senselogic.sitevision.api.user.UserIdentityUtil#getUserIdentity(javax.jcr.Node)} instead
+   */
+  getUserIdentity(aUserNode: Node): Node;
+}
+
+export default UserUtil;

package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts

@@ -0,0 +1,36 @@
+import AuthenticationFilterChain from "../AuthenticationFilterChain";
+
+/**
+ * <p>
+ *    Interface for request filters that want to handle web interactions in order to get login data.
+ * </p>
+ *
+ * <em>
+ *    <strong>Important legacy note!</strong> As of Sitevision 3 this interface has been moved
+ *    (from package senselogic.sitevision.security.jaas.filter.api).
+ *    Previously implemented custom JAAS filters/modules using this interface must be re-compiled in order to run in Sitevision 3.
+ * </em>A filter that can be used to populate the shared state and/or options for a JAAS login module.The shared state username constant.The shared state password constant.The shared state auth type constant.The shared state client address constant.The shared state redirect constant.
+ * @author Rickard Öberg
+ */
+interface AuthenticationFilter {
+  /**
+   * A filter that can be used to populate the shared state and/or options for a JAAS login module.
+   * @param aRequest the request
+   * @param aResponse the response
+   * @param aSharedState a shared state map
+   * @param anOptions an options map
+   * @param aChain a filter chain
+   * @throws IOException if an I/O problem occurred
+   * @throws ServletException if the web container
+   * @throws LoginException if login attempt failed
+   */
+  doFilter(
+    aRequest: unknown,
+    aResponse: unknown,
+    aSharedState: Record<unknown, unknown>,
+    anOptions: Record<unknown, unknown>,
+    aChain: AuthenticationFilterChain
+  ): void;
+}
+
+export default AuthenticationFilter;

package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * <p>
+ *    Interface for request filter chains that want to handle web interactions in order to get login data.
+ * </p>
+ *
+ * <em>
+ *    <strong>Important legacy note!</strong> As of Sitevision 3 this interface has been moved
+ *    (from package senselogic.sitevision.security.jaas.filter.api).
+ *    Previously implemented custom JAAS filters/modules using this interface must be re-compiled in order to run in Sitevision 3.
+ * </em>A filter chain that can be used to populate the shared state and/or options for a JAAS login module.
+ * @author Rickard Öberg
+ */
+interface AuthenticationFilterChain {
+  /**
+   * A filter chain that can be used to populate the shared state and/or options for a JAAS login module.
+   * @param aRequest the request
+   * @param aResponse the response
+   * @param aSharedState a shared state map
+   * @param aChain a filter chain
+   * @throws IOException if an I/O problem occurred
+   * @throws ServletException if the web container
+   * @throws LoginException if login attempt failed
+   */
+  doFilter(
+    aRequest: unknown,
+    aResponse: unknown,
+    aSharedState: Record<unknown, unknown>,
+    aChain: AuthenticationFilterChain
+  ): void;
+}
+
+export default AuthenticationFilterChain;