Story/cite 217 - It should be possible to create personal access tokens

citesphere/pom.xml

@@ -542,14 +542,23 @@
             <version>4.13.1</version>
             <scope>test</scope>
         </dependency>
-
+
+
         <!-- https://mvnrepository.com/artifact/org.mockito/mockito-all -->
+
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-all</artifactId>
             <version>1.10.19</version>
             <scope>test</scope>
         </dependency>
+
+        <dependency>
+    		<groupId>org.mockito</groupId>
+    		<artifactId>mockito-core</artifactId>
+    		<version>3.12.4</version>
+    		<scope>test</scope>
+		</dependency>
 
         <!-- https://mvnrepository.com/artifact/xalan/xalan -->
         <dependency>

citesphere/src/main/java/edu/asu/diging/citesphere/core/exceptions/CannotFindTokenException.java

@@ -0,0 +1,10 @@
+package edu.asu.diging.citesphere.core.exceptions;
+
+public class CannotFindTokenException extends Exception {
+
+    private static final long serialVersionUID = 1L;
+
+    public CannotFindTokenException(String message) {
+        super(message);
+    }
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/model/oauth/IPersonalAccessToken.java

@@ -0,0 +1,24 @@
+package edu.asu.diging.citesphere.core.model.oauth;
+
+import java.time.OffsetDateTime;
+
+/**
+ * Interface representing a personal access token for API access.
+ * Personal access tokens allow users to authenticate against the API
+ * without going through the OAuth authorization code flow.
+ */
+public interface IPersonalAccessToken {
+
+    String getId();
+
+    String getName();
+    void setName(String name);
+
+    String getUsername();
+
+    OffsetDateTime getCreatedAt();
+    void setCreatedAt(OffsetDateTime createdAt);
+
+    boolean isPersonalAccessToken();
+    void setPersonalAccessToken(boolean isPersonalAccessToken);
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/model/oauth/impl/DbAccessToken.java

@@ -1,21 +1,25 @@
 package edu.asu.diging.citesphere.core.model.oauth.impl;
 
+import java.time.OffsetDateTime;
+
 import javax.persistence.Entity;
 import javax.persistence.Id;
 import javax.persistence.Lob;
 
 import org.springframework.security.oauth2.common.OAuth2AccessToken;
 import org.springframework.security.oauth2.provider.OAuth2Authentication;
 
+import edu.asu.diging.citesphere.core.model.oauth.IPersonalAccessToken;
+
 /**
  * Modeled after:
  * https://blog.couchbase.com/custom-token-store-spring-securtiy-oauth2/
  * @author jdamerow
  *
  */
 @Entity
-public class DbAccessToken {
- 
+public class DbAccessToken implements IPersonalAccessToken {
+
     @Id
     private String id;
     private String tokenId;
@@ -28,12 +32,15 @@ public class DbAccessToken {
     private String authentication;
     @Lob
     private String refreshToken;
-
-
+
+    private String name;
+    private OffsetDateTime createdAt;
+    private boolean personalAccessToken;
+
     public OAuth2Authentication getAuthentication() {
         return SerializableObjectConverter.deserialize(authentication);
     }
- 
+
     public void setAuthentication(OAuth2Authentication authentication) {
         this.authentication = SerializableObjectConverter.serialize(authentication);
     }
@@ -97,5 +104,34 @@ public void setRefreshToken(String refreshToken) {
     public void setAuthentication(String authentication) {
         this.authentication = authentication;
     }
-
-}
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    @Override
+    public OffsetDateTime getCreatedAt() {
+        return createdAt;
+    }
+
+    @Override
+    public void setCreatedAt(OffsetDateTime createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    @Override
+    public boolean isPersonalAccessToken() {
+        return personalAccessToken;
+    }
+
+    @Override
+    public void setPersonalAccessToken(boolean personalAccessToken) {
+        this.personalAccessToken = personalAccessToken;
+    }
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/model/oauth/impl/OAuthClient.java

@@ -5,10 +5,15 @@
 import java.util.Set;
 
 import javax.persistence.CascadeType;
+import javax.persistence.DiscriminatorColumn;
+import javax.persistence.DiscriminatorType;
+import javax.persistence.DiscriminatorValue;
 import javax.persistence.ElementCollection;
 import javax.persistence.Entity;
 import javax.persistence.GeneratedValue;
 import javax.persistence.Id;
+import javax.persistence.Inheritance;
+import javax.persistence.InheritanceType;
 import javax.persistence.OneToOne;
 
 import org.hibernate.annotations.GenericGenerator;
@@ -21,6 +26,9 @@
 import edu.asu.diging.citesphere.user.impl.User;
 
 @Entity
+@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
+@DiscriminatorColumn(name = "DTYPE", discriminatorType = DiscriminatorType.STRING)
+@DiscriminatorValue("OAUTH")
 public class OAuthClient implements IOAuthClient, ClientDetails {
 
     /**
@@ -50,6 +58,7 @@ public class OAuthClient implements IOAuthClient, ClientDetails {
     private int accessTokenValiditySeconds;
     private int refereshTokenValiditySeconds;
     private boolean autoApprove;
+
     @OneToOne(targetEntity=User.class)
     private IUser createdBy;
 
@@ -199,7 +208,6 @@ public void setAutoApprove(boolean autoApprove) {
         this.autoApprove = autoApprove;
     }
 
-    @Override
     public IUser getCreatedBy() {
         return this.createdBy;
     }

citesphere/src/main/java/edu/asu/diging/citesphere/core/model/oauth/impl/PersonalAccessTokenOAuthClient.java

@@ -0,0 +1,15 @@
+package edu.asu.diging.citesphere.core.model.oauth.impl;
+
+import javax.persistence.DiscriminatorValue;
+import javax.persistence.Entity;
+
+/**
+ * Subclass of OAuthClient specifically for personal access tokens.
+ * The type itself identifies PAT clients
+ */
+@Entity
+@DiscriminatorValue("PAT")
+public class PersonalAccessTokenOAuthClient extends OAuthClient {
+
+    private static final long serialVersionUID = 1L;
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/oauth/DbAccessTokenRepository.java

@@ -3,6 +3,8 @@
 import java.util.List;
 import java.util.Optional;
 
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import edu.asu.diging.citesphere.core.model.oauth.impl.DbAccessToken;
@@ -28,5 +30,8 @@ public interface DbAccessTokenRepository extends JpaRepository<DbAccessToken, St
     List<DbAccessToken> findByAuthenticationId(String authenticationId);
 
     void deleteByClientIdAndUsername(String clientId, String username);
-
+
+    Page<DbAccessToken> findByUsernameAndPersonalAccessToken(String username, boolean isPersonalAccessToken, Pageable pageable);
+
+    Optional<DbAccessToken> findByIdAndUsername(String id, String username);
 }

citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/oauth/OAuthClientRepository.java

@@ -4,6 +4,11 @@
 
 import edu.asu.diging.citesphere.core.model.oauth.impl.OAuthClient;
 
+/**
+ * Repository for OAuth clients.
+ * Note: Personal access token clients now have their own repository
+ * (PersonalAccessTokenOAuthClientRepository).
+ */
 public interface OAuthClientRepository extends JpaRepository<OAuthClient, String> {
 
 }

citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/oauth/PersonalAccessTokenOAuthClientRepository.java

@@ -0,0 +1,21 @@
+package edu.asu.diging.citesphere.core.repository.oauth;
+
+import java.util.Optional;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+
+import edu.asu.diging.citesphere.core.model.oauth.impl.PersonalAccessTokenOAuthClient;
+
+/**
+ * Repository for personal access token OAuth clients.
+ * This repository handles the specialized PAT client subclass.
+ */
+public interface PersonalAccessTokenOAuthClientRepository
+        extends JpaRepository<PersonalAccessTokenOAuthClient, String> {
+
+    /**
+     * Find a personal access token client by the username of the user who created it.
+     * Each user has at most one PAT client.
+     */
+    Optional<PersonalAccessTokenOAuthClient> findByCreatedByUsername(String username);
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/service/oauth/IOAuthClientManager.java

@@ -27,4 +27,4 @@ public interface IOAuthClientManager {
     OAuthCredentials updateClientSecret(String clientId) throws CannotFindClientException;
 
     List<OAuthClient> getClientsDetails(List<String> clientList);
-}
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/service/oauth/IPersonalAccessTokenManager.java

@@ -0,0 +1,61 @@
+package edu.asu.diging.citesphere.core.service.oauth;
+
+import org.springframework.data.domain.Pageable;
+
+import edu.asu.diging.citesphere.core.exceptions.CannotFindTokenException;
+import edu.asu.diging.citesphere.core.model.oauth.IPersonalAccessToken;
+import edu.asu.diging.citesphere.user.IUser;
+
+/**
+ * Manager for personal access token operations.
+ * Personal access tokens allow users to authenticate against the API
+ * without going through the OAuth authorization code flow.
+ */
+public interface IPersonalAccessTokenManager {
+
+    /**
+     * Creates a new personal access token for the user.
+     *
+     * @param name the user-given name for the token
+     * @param user the user creating the token
+     * @return credentials containing the token ID and token value (shown only once)
+     */
+    PersonalAccessTokenCredentials createToken(String name, IUser user);
+
+    /**
+     * Gets all personal access tokens for the user.
+     *
+     * @param user the user whose tokens to retrieve
+     * @param pageable pagination information
+     * @return paginated result of tokens
+     */
+    PersonalAccessTokenResultPage getTokensForUser(IUser user, Pageable pageable);
+
+    /**
+     * Deletes a personal access token.
+     *
+     * @param tokenId the ID of the token to delete
+     * @param user the user who owns the token
+     * @throws CannotFindTokenException if the token is not found or doesn't belong to the user
+     */
+    void deleteToken(String tokenId, IUser user) throws CannotFindTokenException;
+
+    /**
+     * Regenerates a personal access token, invalidating the old token value
+     * and creating a new one.
+     *
+     * @param tokenId the ID of the token to regenerate
+     * @param user the user who owns the token
+     * @return credentials containing the token ID and new token value
+     * @throws CannotFindTokenException if the token is not found or doesn't belong to the user
+     */
+    PersonalAccessTokenCredentials regenerateToken(String tokenId, IUser user) throws CannotFindTokenException;
+
+    /**
+     * Gets a personal access token by ID.
+     *
+     * @param tokenId the ID of the token
+     * @return the token, or null if not found
+     */
+    IPersonalAccessToken getTokenById(String tokenId);
+}

citesphere/src/main/java/edu/asu/diging/citesphere/core/service/oauth/PersonalAccessTokenCredentials.java

@@ -0,0 +1,43 @@
+package edu.asu.diging.citesphere.core.service.oauth;
+
+/**
+ * This class is a temporary holder for personal access token ID and token value
+ * to be used after creation of a new token. The token value should only be shown
+ * once to the user and not stored unencrypted.
+ */
+public class PersonalAccessTokenCredentials {
+
+    private String tokenId;
+    private String tokenValue;
+    private String name;
+
+    public PersonalAccessTokenCredentials(String tokenId, String tokenValue, String name) {
+        this.tokenId = tokenId;
+        this.tokenValue = tokenValue;
+        this.name = name;
+    }
+
+    public String getTokenId() {
+        return tokenId;
+    }
+
+    public void setTokenId(String tokenId) {
+        this.tokenId = tokenId;
+    }
+
+    public String getTokenValue() {
+        return tokenValue;
+    }
+
+    public void setTokenValue(String tokenValue) {
+        this.tokenValue = tokenValue;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+}