Files
frameworks_base/graphics/java/android/graphics/GraphicBuffer.java
Robert Carr bab740f10e [RESTRICT AUTOMERGE] Careful with screenshots containing secure layers!
For purposes of	the screen rotation animation the system server	is allowed
to capture secure (not protected) layers and trusted not to persist screenshots
which may contain secure layers. However when displaying the screen rotation animation,
the layer the screenshot is placed on will itself not be secure, so if we record
the animation the recording will contain persisted versions of the secure content. Make sure
we use the new API from SurfaceFlinger to set FLAG_SECURE if our screenshot contains secure
content.

Bug: 69703445
Test: Transaction_test#SetFlagsSecureEUidSystem
Change-Id: I0dd36462867da52e6b1451f65f56c2c5d37538f3
2019-05-06 13:24:09 -07:00

333 lines
11 KiB
Java

/*
* Copyright (C) 2013 The Android Open Source Project
*
* 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 android.graphics;
import android.os.Parcel;
import android.os.Parcelable;
/**
* Simple wrapper for the native GraphicBuffer class.
*
* @hide
*/
@SuppressWarnings("UnusedDeclaration")
public class GraphicBuffer implements Parcelable {
// Note: keep usage flags in sync with GraphicBuffer.h and gralloc.h
public static final int USAGE_SW_READ_NEVER = 0x0;
public static final int USAGE_SW_READ_RARELY = 0x2;
public static final int USAGE_SW_READ_OFTEN = 0x3;
public static final int USAGE_SW_READ_MASK = 0xF;
public static final int USAGE_SW_WRITE_NEVER = 0x0;
public static final int USAGE_SW_WRITE_RARELY = 0x20;
public static final int USAGE_SW_WRITE_OFTEN = 0x30;
public static final int USAGE_SW_WRITE_MASK = 0xF0;
public static final int USAGE_SOFTWARE_MASK = USAGE_SW_READ_MASK | USAGE_SW_WRITE_MASK;
public static final int USAGE_PROTECTED = 0x4000;
public static final int USAGE_HW_TEXTURE = 0x100;
public static final int USAGE_HW_RENDER = 0x200;
public static final int USAGE_HW_2D = 0x400;
public static final int USAGE_HW_COMPOSER = 0x800;
public static final int USAGE_HW_VIDEO_ENCODER = 0x10000;
public static final int USAGE_HW_MASK = 0x71F00;
private final int mWidth;
private final int mHeight;
private final int mFormat;
private final int mUsage;
private final boolean mCapturedSecureLayers;
// Note: do not rename, this field is used by native code
private final long mNativeObject;
// These two fields are only used by lock/unlockCanvas()
private Canvas mCanvas;
private int mSaveCount;
// If set to true, this GraphicBuffer instance cannot be used anymore
private boolean mDestroyed;
/**
* Creates new <code>GraphicBuffer</code> instance. This method will return null
* if the buffer cannot be created.
*
* @param width The width in pixels of the buffer
* @param height The height in pixels of the buffer
* @param format The format of each pixel as specified in {@link PixelFormat}
* @param usage Hint indicating how the buffer will be used
*
* @return A <code>GraphicBuffer</code> instance or null
*/
public static GraphicBuffer create(int width, int height, int format, int usage) {
long nativeObject = nCreateGraphicBuffer(width, height, format, usage);
if (nativeObject != 0) {
return new GraphicBuffer(width, height, format, usage, nativeObject);
}
return null;
}
/**
* Private use only. See {@link #create(int, int, int, int, boolean)}.
*/
private GraphicBuffer(int width, int height, int format, int usage, long nativeObject,
boolean capturedSecureLayers) {
mWidth = width;
mHeight = height;
mFormat = format;
mUsage = usage;
mNativeObject = nativeObject;
mCapturedSecureLayers = capturedSecureLayers;
}
/**
* Private use only. See {@link #create(int, int, int, int)}.
*/
private GraphicBuffer(int width, int height, int format, int usage, long nativeObject) {
this(width, height, format, usage, nativeObject, false);
}
/**
* For SurfaceControl JNI.
* @hide
*/
public static GraphicBuffer createFromExisting(int width, int height,
int format, int usage, long unwrappedNativeObject,
boolean capturedSecureLayers) {
long nativeObject = nWrapGraphicBuffer(unwrappedNativeObject);
if (nativeObject != 0) {
return new GraphicBuffer(width, height, format, usage, nativeObject,
capturedSecureLayers);
}
return null;
}
/**
* For SurfaceControl JNI. Provides and ignored value for capturedSecureLayers for backwards
* compatibility
* @hide
*/
public static GraphicBuffer createFromExisting(int width, int height,
int format, int usage, long unwrappedNativeObject) {
return createFromExisting(width, height, format, usage, unwrappedNativeObject, false);
}
/**
* Returns true if the buffer contains visible secure layers.
*/
public boolean doesContainSecureLayers() {
return mCapturedSecureLayers;
}
/**
* Returns the width of this buffer in pixels.
*/
public int getWidth() {
return mWidth;
}
/**
* Returns the height of this buffer in pixels.
*/
public int getHeight() {
return mHeight;
}
/**
* Returns the pixel format of this buffer. The pixel format must be one of
* the formats defined in {@link PixelFormat}.
*/
public int getFormat() {
return mFormat;
}
/**
* Returns the usage hint set on this buffer.
*/
public int getUsage() {
return mUsage;
}
/**
* <p>Start editing the pixels in the buffer. A null is returned if the buffer
* cannot be locked for editing.</p>
*
* <p>The content of the buffer is preserved between unlockCanvas()
* and lockCanvas().</p>
*
* <p>If this method is called after {@link #destroy()}, the return value will
* always be null.</p>
*
* @return A Canvas used to draw into the buffer, or null.
*
* @see #lockCanvas(android.graphics.Rect)
* @see #unlockCanvasAndPost(android.graphics.Canvas)
* @see #isDestroyed()
*/
public Canvas lockCanvas() {
return lockCanvas(null);
}
/**
* Just like {@link #lockCanvas()} but allows specification of a dirty
* rectangle.
*
* <p>If this method is called after {@link #destroy()}, the return value will
* always be null.</p>
*
* @param dirty Area of the buffer that may be modified.
* @return A Canvas used to draw into the surface, or null.
*
* @see #lockCanvas()
* @see #unlockCanvasAndPost(android.graphics.Canvas)
* @see #isDestroyed()
*/
public Canvas lockCanvas(Rect dirty) {
if (mDestroyed) {
return null;
}
if (mCanvas == null) {
mCanvas = new Canvas();
}
if (nLockCanvas(mNativeObject, mCanvas, dirty)) {
mSaveCount = mCanvas.save();
return mCanvas;
}
return null;
}
/**
* Finish editing pixels in the buffer.
*
* <p>This method doesn't do anything if {@link #destroy()} was
* previously called.</p>
*
* @param canvas The Canvas previously returned by lockCanvas()
*
* @see #lockCanvas()
* @see #lockCanvas(android.graphics.Rect)
* @see #isDestroyed()
*/
public void unlockCanvasAndPost(Canvas canvas) {
if (!mDestroyed && mCanvas != null && canvas == mCanvas) {
canvas.restoreToCount(mSaveCount);
mSaveCount = 0;
nUnlockCanvasAndPost(mNativeObject, mCanvas);
}
}
/**
* Destroyes this buffer immediately. Calling this method frees up any
* underlying native resources. After calling this method, this buffer
* must not be used in any way ({@link #lockCanvas()} must not be called,
* etc.)
*
* @see #isDestroyed()
*/
public void destroy() {
if (!mDestroyed) {
mDestroyed = true;
nDestroyGraphicBuffer(mNativeObject);
}
}
/**
* Indicates whether this buffer has been destroyed. A destroyed buffer
* cannot be used in any way: locking a Canvas will return null, the buffer
* cannot be written to a parcel, etc.
*
* @return True if this <code>GraphicBuffer</code> is in a destroyed state,
* false otherwise.
*
* @see #destroy()
*/
public boolean isDestroyed() {
return mDestroyed;
}
@Override
protected void finalize() throws Throwable {
try {
if (!mDestroyed) nDestroyGraphicBuffer(mNativeObject);
} finally {
super.finalize();
}
}
@Override
public int describeContents() {
return 0;
}
/**
* Flatten this object in to a Parcel.
*
* <p>Calling this method will throw an <code>IllegalStateException</code> if
* {@link #destroy()} has been previously called.</p>
*
* @param dest The Parcel in which the object should be written.
* @param flags Additional flags about how the object should be written.
* May be 0 or {@link #PARCELABLE_WRITE_RETURN_VALUE}.
*/
@Override
public void writeToParcel(Parcel dest, int flags) {
if (mDestroyed) {
throw new IllegalStateException("This GraphicBuffer has been destroyed and cannot be "
+ "written to a parcel.");
}
dest.writeInt(mWidth);
dest.writeInt(mHeight);
dest.writeInt(mFormat);
dest.writeInt(mUsage);
nWriteGraphicBufferToParcel(mNativeObject, dest);
}
public static final Parcelable.Creator<GraphicBuffer> CREATOR =
new Parcelable.Creator<GraphicBuffer>() {
public GraphicBuffer createFromParcel(Parcel in) {
int width = in.readInt();
int height = in.readInt();
int format = in.readInt();
int usage = in.readInt();
long nativeObject = nReadGraphicBufferFromParcel(in);
if (nativeObject != 0) {
return new GraphicBuffer(width, height, format, usage, nativeObject);
}
return null;
}
public GraphicBuffer[] newArray(int size) {
return new GraphicBuffer[size];
}
};
private static native long nCreateGraphicBuffer(int width, int height, int format, int usage);
private static native void nDestroyGraphicBuffer(long nativeObject);
private static native void nWriteGraphicBufferToParcel(long nativeObject, Parcel dest);
private static native long nReadGraphicBufferFromParcel(Parcel in);
private static native boolean nLockCanvas(long nativeObject, Canvas canvas, Rect dirty);
private static native boolean nUnlockCanvasAndPost(long nativeObject, Canvas canvas);
private static native long nWrapGraphicBuffer(long nativeObject);
}