Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions api/src/main/java/org/apache/iceberg/RotateEncryptionKeys.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.iceberg;

import java.util.List;

/**
* API for rotating the encryption keys of a table so that they no longer depend on a superseded
* version of the table master key.
*
* <p>Only the keys reachable from the current snapshot are rotated. Older snapshots keep depending
* on the previous keys until they are expired.
*
* <p>{@link #apply()} returns the manifests that will be replaced.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

manifest files are not always replaced.

*/
public interface RotateEncryptionKeys extends PendingUpdate<List<ManifestFile>> {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: we have two interfaces with the same name.
also, "extends PendingUpdate<List>" - manifest files are not always replaced.


/**
* An enum representing the lowest key that is regenerated. The keys above it are regenerated too,
* the keys directly below it are re-wrapped under the new ones, and the keys further below are
* left unchanged.
*/
enum KeyRegenerationLevel {
/** Regenerate the key encryption key without committing a new snapshot. */
KEY_ENCRYPTION_KEY,
/**
* Regenerate the manifest list key and the keys above it, committing a new snapshot without
* rewriting any manifest.
*/
SNAPSHOT_KEY,
/** Regenerate the manifest keys and the keys above them, rewriting every manifest (default). */
MANIFEST_KEY
}

/**
* Sets the lowest key to regenerate.
*
* <p>Consider {@link KeyRegenerationLevel#KEY_ENCRYPTION_KEY} or {@link
* KeyRegenerationLevel#SNAPSHOT_KEY} when rewriting every manifest is too expensive.
*
* @param level the lowest key to regenerate
* @return this for method chaining
*/
RotateEncryptionKeys keyRegenerationLevel(KeyRegenerationLevel level);
}
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,10 @@ default RepairTable repairTable(Table table) {
throw new UnsupportedOperationException(
this.getClass().getName() + " does not implement repairTable");
}

/** Instantiates an action to rotate the encryption keys of a table. */
default RotateEncryptionKeys rotateEncryptionKeys(Table table) {
throw new UnsupportedOperationException(
this.getClass().getName() + " does not implement rotateEncryptionKeys");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.iceberg.actions;

import org.apache.iceberg.ManifestFile;
import org.apache.iceberg.RotateEncryptionKeys.KeyRegenerationLevel;

/**
* An action that rotates the encryption keys of a table.
*
* <p>Similar to {@link org.apache.iceberg.RotateEncryptionKeys} but may use a query engine to
* distribute parts of the work.
*/
public interface RotateEncryptionKeys
extends SnapshotUpdate<RotateEncryptionKeys, RotateEncryptionKeys.Result> {

/**
* Sets the lowest key to regenerate.
*
* @param level the lowest key to regenerate
* @return this for method chaining
*/
RotateEncryptionKeys keyRegenerationLevel(KeyRegenerationLevel level);

/** The action result that contains a summary of the execution. */
interface Result {
/** Returns the manifests written with new keys. */
Iterable<ManifestFile> addedManifests();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems specific to a single level. Also, "written with new keys" needs clarification.

}
}
Loading