Store Your Sensitive Data Safely When Sharing a Sketch

Arduino Web Editor

Arduino IDE

Often in your sketch, there is some sensitive data that you’d like to keep private, which could accidentally become public when published on GitHub or when you <a href="https://create.arduino.cc/projecthub/Arduino_Genuino/share-your-sketches-on-the-arduino-web-editor-00a02c">share your sketch with someone else via URL.</a> This sensitive information may include Wi-Fi network names and passwords, API key, and so on. But now, you can add a secret tab to your sketch and store your private data there.This feature has been designed specifically for the <a href="https://create.arduino.cc/editor">Arduino Create Editor.</a> If you have yet to try it, follow <a href="https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-the-arduino-web-editor-4b3e4a">this tutorial to get started </a>— all you need is an Arduino ID. <h3 >How it works</h3>Basically every time you type <code >SECRET_SOMETHING</code> in your sketch and save it, we will create a Secret tab for you to fill out.Let’s start with an example, just so you can see how it works. Go to the Libraries panel and type ‘Wifi101’ in the search tab, then click on the ConnectWithWPA example. You can also click on <a href="https://create.arduino.cc/editor/Arduino_Genuino/2ab7cb05-7f86-41cb-994f-d121d6f3bf34/preview">this link</a> and add the example to your sketchbook.<figure><img src=https://projects.arduinocontent.cc/cf2e0380-6246-4f1f-af61-2291fc261b5b.png /><figcaption> </figcaption></figure>As you can see, there are some identifiers like <code >SECRET_SIID</code> and <code >SECRET_PSW</code>. If you now click on the tab called “Secret,” you will notice some input fields where you can fill in your data. If you have a <a href="https://store.arduino.cc/arduino-mkr1000-with-headers-mounted">MKR1000 </a>lying around, you can upload this sketch on it and watch your board connect to Internet (just make sure you join a 2GHz WiFi network).<div id="gallery"><img id="gallery" src=https://projects.arduinocontent.cc/a75dee28-5523-40f5-90fa-2293c1dfc48a.png /><figcaption> </figcaption><img id="gallery" src=https://projects.arduinocontent.cc/da66116c-d7c8-45ec-a71b-1ee3d7ae5f1d.png /><figcaption> </figcaption></div><h3 >How to Add Secret Values to Your Own Sketch</h3>Write your sketch as you would normally. <figure><img src=https://projects.arduinocontent.cc/465f3165-0442-444c-9a69-a311ab5b7bae.png /><figcaption> </figcaption></figure>In your sketch, replace the strings containing sensitive data by writing <code >SECRET_NAMEYOUWANT</code>. For instance, if your string is <code >&#34;psw”</code>, you should replace it with <code >SECRET_PSW</code>. Make sure all these identifiers are in caps. <figure><img src=https://projects.arduinocontent.cc/b935bb0d-2ec4-4616-ba4d-d12132ceacdf.png /><figcaption> </figcaption></figure>The Secret tab will be automatically created as soon as you type <code >SECRET_SOMETHING</code>. Go to Secret tab and fill out the fields with the sensitive values.<figure><img src=https://projects.arduinocontent.cc/460c881b-aac4-4790-ba6a-b7b3b3967ae5.png /><figcaption> </figcaption></figure>That's it! If you share this sketch with someone via URL or if you download it, the values on the tab will be blank. <figure><img src=https://projects.arduinocontent.cc/d98a4ee6-fd8c-4ccf-93f6-1ce72d6776de.png /><figcaption> </figcaption></figure>Alternatively, you can also click on the tab button and add the Secret tab directly from there. These instructions will be reported for quick reference.<figure><img src=https://projects.arduinocontent.cc/07ac4378-6385-418c-a9dc-149a82d1736a.png /><figcaption> </figcaption></figure>If you download a sketch, we will automatically create a file called arduino_secrets.h and add it to the .zip file. If you open the sketch with the Desktop IDE, you will be able to fill up this tab with your secrets as usual.<figure><img src=https://projects.arduinocontent.cc/e66e4811-2f37-4b6d-9cab-1bb9d5ca7b52.png /><figcaption> </figcaption></figure><h3 >Tech Details</h3>All the values you enter will be considered strings.The secrets are stored as plain text values, and will only be available when the user logs in to his/her account and looks at their own sketches in their personal sketchbooks.You will be able to delete the Secret tab simply by removing the <code >SECRET_XX</code> identifiers from the .ino file.

Store Your Sensitive Data Safely When Sharing a Sketch

If there is sensitive data that you want to keep private when sharing a sketch, add a secret tab and store your private info there!