[flutter_tools] wire up complete support for Dart obfuscation #50509

jonahwilliams · 2020-02-10T22:08:04Z

Description

Previously Dart obfuscation was supported in a somewhat ad-hoc fashion via extra-gen-snapshot-args for Android and tool source code modification for iOS (see https://github.com/flutter/flutter/wiki/Obfuscating-Dart-Code )

This PR adds "complete" support by wiring it up through the existing build flags and infrastructure in a similar manner to the split-debug-info flag.

#50043

My understanding of the obfuscation map is that it would only be necessary if the --obfuscate flag is not combined with the --split-debug-info option. In that case, we might be able to simplify this a bit by constraining obfuscate to require split-debug-info. The user still only has to track one auxiliary file and we in turn simplify the supported configuration. @zanderso for thoughts on command line usability.

zanderso · 2020-02-13T20:58:39Z

How would deobfuscating work? Also flutter symbolize?

…ion_support

jonahwilliams · 2020-02-14T21:02:09Z

Discussed offline a bit: the obfuscation does not apply to the debug symbols, so the workflow is the same for --split-debug-info with or without --obfuscate. The only time the obfuscation map is needed is if you are not using split-debug-info - but there is basically no reason not to use them together. If you're going to put in the extra work to track an additional file, might as well make your code size smaller too

…ion_support

dnfield

LGTM

zanderso · 2020-02-24T23:02:43Z

packages/flutter_tools/lib/src/runner/flutter_command.dart

+    argParser.addFlag(FlutterOptions.kDartObfuscationOption,
+      help: 'In a release build, this flag removes identifiers and replaces them '
+        'with randomized values for the purposes of source code obfuscation. The '
+        'mapping between the values and the original identifiers is stored the '


is stored the -> is stored in the

zanderso · 2020-02-24T23:07:02Z

packages/flutter_tools/lib/src/runner/flutter_command.dart

+      help: 'In a release build, this flag removes identifiers and replaces them '
+        'with randomized values for the purposes of source code obfuscation. The '
+        'mapping between the values and the original identifiers is stored the '
+        'symbol map created with the "--split-debug-info" option. For an app built '


What happens when someone passes --obfuscate but not --split-debug-info?

We don't output the obfuscation map. I think this is okay for now, since we don't actually have a tool to de-obfuscate a stack trace, only flutter symbols. I can document that this should always be combined with split-debug-info

If it should always be paired with --split-debug-info then it would be good to give an error otherwise, or fill in a default value for it, I think.

Updated so that obfuscate requires split-debug-info

jonahwilliams · 2020-02-26T16:29:14Z

@zanderso did you have any more comments on this?

…ion_support

…utter into add_obfuscation_support

zanderso

lgtm

brunovsiqueira · 2020-03-02T19:04:50Z

How can I use this feature? I think I'm not getting it correctly.

MohsinN · 2020-03-20T11:03:33Z

@jonahwilliams Can you please share steps to execute this feature? No updated has been posted on guide.

jonahwilliams · 2020-03-20T17:54:10Z

I've filled an issue to update the documentation: flutter/website#3827

I also tried to make the --obfuscate option documentation fairly complete:

flutter build apk -h:

  --split-debug-info=</project-name/v1.2.3/>    In a release build, this flag reduces application size by storing Dart program
                                                  symbols in a separate file on the host rather than in the application. The value
                                                  of the flag should be a directory where program symbol files can be stored for
                                                  later use. These symbol files contain the information needed to symbolize Dart
                                                  stack traces. For an app built with this flag, the 'flutter symbolize' command
                                                  with the right program symbol file is required to obtain a human readable stack
                                                  trace.

    --[no-]obfuscate                              In a release build, this flag removes identifiers and replaces them with
                                                  randomized values for the purposes of source code obfuscation. This flag must
                                                  always be combined with "--split-debug-info" option, the mapping between the
                                                  values and the original identifiers is stored in the symbol map created in the
                                                  specified directory. For an app built with this flag, the 'flutter symbolize'
                                                  command with the right program symbol file is required to obtain a human readable
                                                  stack trace.
                                                  
                                                  Because all identifiers are renamed, methods like Object.runtimeType,
                                                  Type.toString, Enum.toString, Stacktrace.toString, Symbol.toString (for constant
                                                  symbols or those generated by runtime system) will return obfuscated results. Any
                                                  code or tests that rely on exact names will break.

[flutter_tools] wire up complete support for Dart obfuscation

6c825ed

fluttergithubbot added tool Affects the "flutter" command-line tool. See also t: labels. work in progress; do not review labels Feb 10, 2020

googlebot added the cla: yes label Feb 10, 2020

Merge branch 'master' of github.com:flutter/flutter into add_obfuscat…

a6cd733

…ion_support

jonahwilliams added 6 commits February 15, 2020 16:12

Merge branch 'master' of github.com:flutter/flutter into add_obfuscat…

1798c1b

…ion_support

update to only support --obfuscate flags

95289ec

update and add unit tests

10feecd

add integration tests for obfuscation

a0c22cb

Update .gitignore

b1edac1

Update manifest.yaml

9f5ce86

jonahwilliams changed the title ~~[WIP][flutter_tools] wire up complete support for Dart obfuscation~~ [flutter_tools] wire up complete support for Dart obfuscation Feb 21, 2020

jonahwilliams removed the work in progress; do not review label Feb 21, 2020

jonahwilliams marked this pull request as ready for review February 21, 2020 17:14

jonahwilliams requested a review from dnfield February 21, 2020 17:14

fluttergithubbot added the c: contributor-productivity Team-specific productivity, code health, technical debt. label Feb 21, 2020

dnfield approved these changes Feb 21, 2020

View reviewed changes

jonahwilliams requested a review from zanderso February 24, 2020 22:21

zanderso reviewed Feb 24, 2020

View reviewed changes

Update flutter_command.dart

6903f0d

jonahwilliams added 3 commits February 26, 2020 13:32

Merge branch 'master' of github.com:flutter/flutter into add_obfuscat…

e028eb9

…ion_support

Merge branch 'add_obfuscation_support' of github.com:jonahwilliams/fl…

504f57a

…utter into add_obfuscation_support

make obfuscate require split debug info

e3feb1f

jonahwilliams requested a review from zanderso February 27, 2020 16:08

zanderso approved these changes Feb 27, 2020

View reviewed changes

jonahwilliams merged commit 08d079f into flutter:master Feb 27, 2020

jonahwilliams deleted the add_obfuscation_support branch February 27, 2020 16:58

jmagman mentioned this pull request Mar 4, 2020

Mark devicelab tests as no longer flaky #51977

Merged

10 tasks

xster mentioned this pull request Apr 30, 2020

Add obfuscation option to flutter build aar also #56068

Closed

github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2021

[flutter_tools] wire up complete support for Dart obfuscation #50509

[flutter_tools] wire up complete support for Dart obfuscation #50509

Uh oh!

Conversation

jonahwilliams commented Feb 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

zanderso commented Feb 13, 2020

Uh oh!

jonahwilliams commented Feb 14, 2020

Uh oh!

dnfield left a comment

Choose a reason for hiding this comment

Uh oh!

zanderso Feb 24, 2020

Choose a reason for hiding this comment

Uh oh!

zanderso Feb 24, 2020

Choose a reason for hiding this comment

Uh oh!

jonahwilliams Feb 24, 2020

Choose a reason for hiding this comment

Uh oh!

zanderso Feb 26, 2020

Choose a reason for hiding this comment

Uh oh!

jonahwilliams Feb 26, 2020

Choose a reason for hiding this comment

Uh oh!

jonahwilliams commented Feb 26, 2020

Uh oh!

zanderso left a comment

Choose a reason for hiding this comment

Uh oh!

brunovsiqueira commented Mar 2, 2020

Uh oh!

MohsinN commented Mar 20, 2020

Uh oh!

jonahwilliams commented Mar 20, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jonahwilliams commented Feb 10, 2020 •

edited

Loading