Add a copy of Rlog for the telephony mainline module (eba99023) · Commits · e / os / android_frameworks_base

core/java/android/util/Log.java

+19 −0

Original line number	Diff line number	Diff line
		@@ -386,6 +386,25 @@ public final class Log {
		@UnsupportedAppUsage
		public static native int println_native(int bufID, int priority, String tag, String msg);

		/**
		* Send a log message to the "radio" log buffer, which can be dumped with
		* {@code adb logcat -b radio}.
		*
		* <p>Only the telephony mainline module should use it.
		*
		* <p>Note ART will protect {@code MODULE_LIBRARIES} system APIs from regular app code.
		*
		* @param priority Log priority.
		* @param tag Used to identify the source of a log message. It usually identifies
		* the class or activity where the log call occurs.
		* @param message The message you would like logged.
		* @hide
		*/
		public static int logToRadioBuffer(@Level int priority, @Nullable String tag,
		@Nullable String message) {
		return println_native(LOG_ID_RADIO, priority, tag, message);
		}

		/**
		* Return the maximum payload the log daemon accepts without truncation.
		* @return LOGGER_ENTRY_MAX_PAYLOAD.

telephony/java/android/telephony/TelephonyManager.java

+1 −0

Original line number	Diff line number	Diff line
		@@ -106,6 +106,7 @@ import com.android.internal.telephony.OperatorInfo;
		import com.android.internal.telephony.PhoneConstants;
		import com.android.internal.telephony.RILConstants;
		import com.android.internal.telephony.SmsApplication;
		import com.android.telephony.Rlog;

		import dalvik.system.VMRuntime;

telephony/java/com/android/telephony/Rlog.java

0 → 100644

+154 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2020 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 com.android.telephony;

		import android.text.TextUtils;
		import android.util.Base64;
		import android.util.Log;

		import com.android.internal.telephony.util.TelephonyUtils;

		import java.security.MessageDigest;
		import java.security.NoSuchAlgorithmException;

		/**
		* A copy of {@link android.telephony.Rlog} to be used within the telephony mainline module.
		*
		* @hide
		*/
		public final class Rlog {

		private static final boolean USER_BUILD = TelephonyUtils.IS_USER;

		private Rlog() {
		}

		private static int log(int priority, String tag, String msg) {
		return Log.logToRadioBuffer(priority, tag, msg);
		}

		public static int v(String tag, String msg) {
		return log(Log.VERBOSE, tag, msg);
		}

		public static int v(String tag, String msg, Throwable tr) {
		return log(Log.VERBOSE, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		public static int d(String tag, String msg) {
		return log(Log.DEBUG, tag, msg);
		}

		public static int d(String tag, String msg, Throwable tr) {
		return log(Log.DEBUG, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		public static int i(String tag, String msg) {
		return log(Log.INFO, tag, msg);
		}

		public static int i(String tag, String msg, Throwable tr) {
		return log(Log.INFO, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		public static int w(String tag, String msg) {
		return log(Log.WARN, tag, msg);
		}

		public static int w(String tag, String msg, Throwable tr) {
		return log(Log.WARN, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		public static int w(String tag, Throwable tr) {
		return log(Log.WARN, tag, Log.getStackTraceString(tr));
		}

		public static int e(String tag, String msg) {
		return log(Log.ERROR, tag, msg);
		}

		public static int e(String tag, String msg, Throwable tr) {
		return log(Log.ERROR, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		public static int println(int priority, String tag, String msg) {
		return log(priority, tag, msg);
		}

		public static boolean isLoggable(String tag, int level) {
		return Log.isLoggable(tag, level);
		}

		/**
		* Redact personally identifiable information for production users.
		* @param tag used to identify the source of a log message
		* @param pii the personally identifiable information we want to apply secure hash on.
		* @return If tag is loggable in verbose mode or pii is null, return the original input.
		* otherwise return a secure Hash of input pii
		*/
		public static String pii(String tag, Object pii) {
		String val = String.valueOf(pii);
		if (pii == null \|\| TextUtils.isEmpty(val) \|\| isLoggable(tag, Log.VERBOSE)) {
		return val;
		}
		return "[" + secureHash(val.getBytes()) + "]";
		}

		/**
		* Redact personally identifiable information for production users.
		* @param enablePiiLogging set when caller explicitly want to enable sensitive logging.
		* @param pii the personally identifiable information we want to apply secure hash on.
		* @return If enablePiiLogging is set to true or pii is null, return the original input.
		* otherwise return a secure Hash of input pii
		*/
		public static String pii(boolean enablePiiLogging, Object pii) {
		String val = String.valueOf(pii);
		if (pii == null \|\| TextUtils.isEmpty(val) \|\| enablePiiLogging) {
		return val;
		}
		return "[" + secureHash(val.getBytes()) + "]";
		}

		/**
		* Returns a secure hash (using the SHA1 algorithm) of the provided input.
		*
		* @return "****" if the build type is user, otherwise the hash
		* @param input the bytes for which the secure hash should be computed.
		*/
		private static String secureHash(byte[] input) {
		// Refrain from logging user personal information in user build.
		if (USER_BUILD) {
		return "****";
		}

		MessageDigest messageDigest;

		try {
		messageDigest = MessageDigest.getInstance("SHA-1");
		} catch (NoSuchAlgorithmException e) {
		return "####";
		}

		byte[] result = messageDigest.digest(input);
		return Base64.encodeToString(
		result, Base64.URL_SAFE \| Base64.NO_PADDING \| Base64.NO_WRAP);
		}
		}