Get rid of StorageProfileDtoWrapper.coerce.

[dkocher]

May need adjustments to API.

• StorageProfileDto

[chenkins]

classDiagram
    class StorageProfileDto {
        %% @Id
        @JsonProperty(value = "id", required = true)
        %% @Schema(description = "Technical identifier for a storage profile. Must be unique UUID. Clients will use this as vendor in profile and provider in vault bookmark")
        UUID id;
        @JsonProperty(value = "name", required = true)
        %% @Schema(description = "Displayed when choosing type of a new vault in dropdown.")
        String name;
        %% //======================================================================
        %% //(3) client profile
        %% //======================================================================
        %% //----------------------------------------------------------------------
        %% //(3a) STS and permanent client profile attributes
        %% //----------------------------------------------------------------------
        @JsonProperty(value = "protocol", required = true)
        %% @Schema(description = "Storage protocol: S3 (permanent credentials) or S3STS (STS).")
        Protocol protocol;
        @JsonProperty(value = "archived", required = true, defaultValue = "false")
        %% @Schema(description = "For archived storage profiles, no vaults can be created any more.")
        boolean archived;
    }

    class StorageProfileS3Dto {
        %% //======================================================================
        %% //(1) STS and permanent:
        %% // - bucket creation frontend/desktop client(STS)
        %% // - template upload(STS and permanent)
        %% // - client profile(STS and permanent)
        %% //======================================================================
        @JsonProperty(value = "scheme", defaultValue = "https")
        %% @Schema(description = "Scheme of S3 endpoint for template upload/bucket creation. Defaults to default for protocol, i.e. https in most cases.", example = "https", nullable = true)
        String scheme;
        @JsonProperty("hostname")
        %% @Schema(description = "Hostname S3 endpoint for template upload/bucket creation. Defaults to AWS SDK default.", example = "s3-us-gov-west-1.amazonaws.com", nullable = true)
        String hostname;
        @JsonProperty("port")
        %% @Schema(description = "Port S3 endpoint for template upload/bucket creation. Defaults to default port for scheme.", example = "443", nullable = true)
        Integer port;
        @JsonProperty(value = "withPathStyleAccessEnabled")
        %% @Schema(description = "Whether to use path style for S3 endpoint for template upload/bucket creation.", example = "false", defaultValue = "false")
        Boolean withPathStyleAccessEnabled = false;
        @JsonProperty(value = "storageClass", defaultValue = "STANDARD")
        %% @Schema(description = "Storage class for upload. Defaults to STANDARD", example = "STANDARD", required = true)
        S3_STORAGE_CLASSES storageClass = S3_STORAGE_CLASSES.STANDARD;
    }

    class StorageProfileS3STSDto {
        %% //======================================================================
        %% //(2) STS only: bucket creation
        %% //======================================================================
        @JsonProperty(value = "region", required = true, defaultValue = "us-east-1")
        %% @Schema(description = "Default region selected in the frontend/client to create bucket in.", example = "443", defaultValue = "us-east-1")
        String region = "us-east-1";
        @JsonProperty(value = "regions", required = true)
        %% @Schema(description = "List of selectable regions in the frontend/client to create bucket in. Defaults to full list from AWS SDK.")
        List<String> regions = Region.regions().stream().map(Region:: id).toList();
        @JsonProperty(value = "bucketPrefix", required = true)
        %% @Schema(description = "Buckets are create with name <bucket prefix><vault UUID>.", example = "cipherduck")
        String bucketPrefix;
        @JsonProperty(value = "stsRoleArnClient", required = true)
        %% @Schema(description = "STS role for clients to assume to create buckets. Will be the same as stsRoleArnHub for AWS, different for MinIO.", example = "arn:aws:iam::<ACCOUNT ID>:role/cipherduck-createbucket")
        String stsRoleArnClient;
        @JsonProperty(value = "stsRoleArnHub", required = true)
        %% @Schema(description = "STS role for frontend to assume to create buckets (used with inline policy and passed to hub storage). Will be the same as stsRoleArnClient for AWS, different for MinIO.", example = "arn:aws:iam::<ACCOUNT ID>:role/cipherduck-createbucket")
        String stsRoleArnHub;
        @JsonProperty("stsEndpoint")
        %% @Schema(description = "STS endpoint to use for AssumeRoleWithWebIdentity and AssumeRole for getting a temporary access token passed to the storage. Defaults to AWS SDK default.", nullable = true)
        String stsEndpoint;
        @JsonProperty(value = "bucketVersioning", defaultValue = "true", required = true)
        %% @Schema(description = "Enable bucket versioning upon bucket creation", defaultValue = "true", required = true)
        Boolean bucketVersioning = true;
        @JsonProperty(value = "bucketAcceleration")
        %% @Schema(description = "Enable bucket versioning upon bucket creation (null for MinIO)", nullable = true)
        Boolean bucketAcceleration = null;
        @JsonProperty(value = "bucketEncryption", required = true)
        %% @Schema(description = "Enable bucket versioning upon bucket creation", required = true)
        S3_SERVERSIDE_ENCRYPTION bucketEncryption = S3_SERVERSIDE_ENCRYPTION.NONE;
        %% //----------------------------------------------------------------------
        %% //(3b) STS client profile custom properties
        %% //----------------------------------------------------------------------
        @JsonProperty(value = "stsRoleArn", required = true)
        %% @Schema(description = "roleArn to for STS AssumeRoleWithWebIdentity (AWS and MinIO)", example = "arn:aws:iam::930717317329:role/cipherduck_chain_01")
        String stsRoleArn;
        @JsonProperty(value = "stsRoleArn2")
        %% @Schema(description = "roleArn to assume for STS AssumeRole in role chaining (AWS only, not MinIO)", example = "arn:aws:iam::930717317329:role/cipherduck_chain_02", nullable = true)
        String stsRoleArn2;
        @JsonProperty(value = "stsDurationSeconds", required = false)
        %% @Schema(description = "Token lifetime for STS tokens assumed. Defaults to AWS/MinIO defaults", nullable = true)
        Integer stsDurationSeconds;
    }

    StorageProfileDto <|-- StorageProfileS3Dto
    StorageProfileS3Dto <|-- StorageProfileS3STSDto

Loading

[chenkins]

Relates to #66

[chenkins]

Approaches:

• can generator generate hierarchy now? -> ⛔
• client: can we get rid of coerce without touching backend as well? ❓
• backend and client: merge S3/S3STS, rename protocol to something else. Only Dto (API-level) or also table level?