[libcamera-devel,v2] android: jpeg: exif: Sanitize ASCII strings with utils::toAscii()

Message ID 20201005165701.77469-1-email@uajain.com
State Accepted
Headers show
Series
  • [libcamera-devel,v2] android: jpeg: exif: Sanitize ASCII strings with utils::toAscii()
Related show

Commit Message

Umang Jain Oct. 5, 2020, 4:57 p.m. UTC
Use the newly introduced utils::toAscii() utility to remove all
non-ASCII characters for EXIF_FORMAT_ASCII strings.

Signed-off-by: Umang Jain <email@uajain.com>
---
 src/android/jpeg/exif.cpp | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

---

Changes in v2:
 - Set new length for sanitized string.

Comments

Laurent Pinchart Oct. 5, 2020, 5:08 p.m. UTC | #1
On Mon, Oct 05, 2020 at 10:27:01PM +0530, Umang Jain wrote:
> Use the newly introduced utils::toAscii() utility to remove all
> non-ASCII characters for EXIF_FORMAT_ASCII strings.
> 
> Signed-off-by: Umang Jain <email@uajain.com>
> ---
>  src/android/jpeg/exif.cpp | 16 ++++++++++++----
>  1 file changed, 12 insertions(+), 4 deletions(-)
> 
> ---
> 
> Changes in v2:
>  - Set new length for sanitized string. 
> 
> diff --git a/src/android/jpeg/exif.cpp b/src/android/jpeg/exif.cpp
> index 3fd5d55..56e3c6a 100644
> --- a/src/android/jpeg/exif.cpp
> +++ b/src/android/jpeg/exif.cpp
> @@ -8,6 +8,7 @@
>  #include "exif.h"
>  
>  #include "libcamera/internal/log.h"
> +#include "libcamera/internal/utils.h"
>  
>  using namespace libcamera;
>  
> @@ -171,15 +172,22 @@ void Exif::setRational(ExifIfd ifd, ExifTag tag, ExifRational item)
>  
>  void Exif::setString(ExifIfd ifd, ExifTag tag, ExifFormat format, const std::string &item)
>  {
> -	/* Pad 1 extra byte for null-terminated string in ASCII format. */
> -	size_t length = format == EXIF_FORMAT_ASCII ?
> -			item.length() + 1 : item.length();
> +	size_t length = item.length();
> +	std::string str = item;
> +	if (format == EXIF_FORMAT_ASCII) {
> +		str = utils::toAscii(str);
> +		/*
> +		 * Get new length and pad 1 extra byte to null-terminate
> +		 * the ASCII string.
> +		 */
> +		length = str.length() + 1;
> +	}

Small optimization, we can avoid computing the size before toAscii(). We
can also avoid a copy of the string for the non-ascii case.

	std::string ascii;
	size_t length;
	char *str;

	if (format == EXIF_FORMAT_ASCII) {
		ascii = utils::toAscii(item);
		str = ascii.c_str();

		/* Pad 1 extra byte to null-terminate the ASCII string. */
		length = ascii.length() + 1;
	} else {
		str = item.c_str();

		/*
		 * Strings stored in different formats (EXIF_FORMAT_UNDEFINED)
		 * are not null-terminated.
		 */
		length = item.length();
	}

	ExifEntry *entry = createEntry(ifd, tag, format, length, length);
	if (!entry)
		return;

	memcpy(entry->data, str, length);

If you think that's not a useful optimization, feel free to drop it.

>  	ExifEntry *entry = createEntry(ifd, tag, format, length, length);
>  	if (!entry)
>  		return;
>  
> -	memcpy(entry->data, item.c_str(), length);
> +	memcpy(entry->data, str.c_str(), length);
>  	exif_entry_unref(entry);
>  }
>

Patch

diff --git a/src/android/jpeg/exif.cpp b/src/android/jpeg/exif.cpp
index 3fd5d55..56e3c6a 100644
--- a/src/android/jpeg/exif.cpp
+++ b/src/android/jpeg/exif.cpp
@@ -8,6 +8,7 @@ 
 #include "exif.h"
 
 #include "libcamera/internal/log.h"
+#include "libcamera/internal/utils.h"
 
 using namespace libcamera;
 
@@ -171,15 +172,22 @@  void Exif::setRational(ExifIfd ifd, ExifTag tag, ExifRational item)
 
 void Exif::setString(ExifIfd ifd, ExifTag tag, ExifFormat format, const std::string &item)
 {
-	/* Pad 1 extra byte for null-terminated string in ASCII format. */
-	size_t length = format == EXIF_FORMAT_ASCII ?
-			item.length() + 1 : item.length();
+	size_t length = item.length();
+	std::string str = item;
+	if (format == EXIF_FORMAT_ASCII) {
+		str = utils::toAscii(str);
+		/*
+		 * Get new length and pad 1 extra byte to null-terminate
+		 * the ASCII string.
+		 */
+		length = str.length() + 1;
+	}
 
 	ExifEntry *entry = createEntry(ifd, tag, format, length, length);
 	if (!entry)
 		return;
 
-	memcpy(entry->data, item.c_str(), length);
+	memcpy(entry->data, str.c_str(), length);
 	exif_entry_unref(entry);
 }