updatetool (#10)

Author: adamyg

AutoUpdater.vs160.sln

@@ -30,6 +30,11 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "SignTool", "msvc\SignTool.v
 		{EBA010B5-F14F-4AED-9E6B-D519BACD1615} = {EBA010B5-F14F-4AED-9E6B-D519BACD1615}
 	EndProjectSection
 EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "UpdateTool", "msvc\UpdateTool.vs160.vcxproj", "{A1BE9C67-1B56-41BC-A518-76C03C53FC42}"
+	ProjectSection(ProjectDependencies) = postProject
+		{EBA010B5-F14F-4AED-9E6B-D519BACD1615} = {EBA010B5-F14F-4AED-9E6B-D519BACD1615}
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Win32 = Debug|Win32
@@ -86,6 +91,14 @@ Global
 		{A1BE9C67-1B56-41BC-A518-76C03C53FCF2}.Release|Win32.Build.0 = Release|Win32
 		{A1BE9C67-1B56-41BC-A518-76C03C53FCF2}.Release|x64.ActiveCfg = Release|x64
 		{A1BE9C67-1B56-41BC-A518-76C03C53FCF2}.Release|x64.Build.0 = Release|x64
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Debug|Win32.ActiveCfg = Debug|Win32
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Debug|Win32.Build.0 = Debug|Win32
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Debug|x64.ActiveCfg = Debug|x64
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Debug|x64.Build.0 = Debug|x64
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Release|Win32.ActiveCfg = Release|Win32
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Release|Win32.Build.0 = Release|Win32
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Release|x64.ActiveCfg = Release|x64
+		{A1BE9C67-1B56-41BC-A518-76C03C53FC42}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

README.md

@@ -58,7 +58,7 @@ signtool -K application_private.pem -x 1 -v 0.0.1 \
 The resulting signature block is exported that can then by cut & pasted into the application manifest,
 which you can value add to include a change notice related to the installer release.
 
-```
+```xml
 <title></title>
 <link></link>
 <description></description>
@@ -76,9 +76,31 @@ which you can value add to include a change notice related to the installer rele
    type="application/octet-stream" />
 ```
 
-Example application.manifest.
+### sign application integration
+
+To simplifying application integration a customised version of _signtool_ can be built.
+Using the provided application shim, default arguments can be provided stream-lining software management.
+
+```C++
+//
+// signtool specialisation
+//
+#include "libappupdater/sign/signtoolshim.h"       // SignToolShim()
 
+int
+main(int argc, char *argv[])
+{
+   struct SignToolArgs args = {0};
+
+   args.hosturl = "https://github.com/user/repo~application.manifest";
+   
+   return SignToolShim(argc, argv, &args);
+}
 ```
+
+## Example application.manifest
+
+```xml
 <?xml version="1.0" encoding="utf-8"?>
 <manifest>
    <channel name="release">
@@ -127,6 +149,66 @@ ul.b { list-style-type: square; padding: 0px; margin: 0px; }
 </manifest>
 ```
 
+### Updater application integration
+
+Application integration can be achieved using several methods.
+
+   - As a stand-alone updater application; or
+   - embedded within the target application.
+
+Working examples are provided as test applications. For following demonstrates one method
+
+#### Standalone integration:
+
+```C++
+#include "libappupdater/update/updatetoolshim.h"   // UpdaterToolShim()
+
+#include "version.h"                               // VERSION_TAG, build-system version.
+#include "private_key.h"                           // PUBLIC_KEY and KEY_VERSION, see: keygen
+
+int
+main(int argc, char *argv[])
+{
+   struct UpdateToolArgs args = {0};
+
+   args.title = "MyApplication updater";
+   args.version = VERSION_TAG;
+   args.hosturl = "https://github.com/user/repo~application.manifest";
+   args.publickey = PUBLIC_KEY;
+   args.keyversion = KEY_VERSION;     
+  
+   return UpdateToolShim(argc, argv, &args);
+}
+```
+
+#### Embedded integration:
+
+```C++
+#include "libappupdater/src/AutoUpdater.h"         // AutoUpdater
+
+#include "version.h"                               // VERSION_TAG, build-system version.
+#include "private_key.h"                           // PUBLIC_KEY and KEY_VERSION, see: keygen
+
+int
+Application::CheckForUpdates()
+{
+   AutoUpdater au;
+
+   // Note parameters stated either by:
+   //    o Explicit run-time arguments; or
+   //    o Application resource elements, alone-side VERSIONINFO information; 
+   //    see AutoConfig.h for further details.
+   //
+   au.EnableDialog();
+   au.AppName("Application Name");
+   au.AppVersion(VERSION_TAG);
+   au.HostURL("https://github.com/user/repo~application.manifest");
+   au.PublicKey(PUBLIC_KEY, KEY_VERSION);
+
+   au.Execute(AutoUpdater::ExecuteAuto, true);
+}
+```
+
 ## License
 
       MIT License
@@ -151,4 +233,3 @@ ul.b { list-style-type: square; padding: 0px; margin: 0px; }
       LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
       OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
       SOFTWARE.
-

msvc/SignTool.vs160.vcxproj

@@ -21,7 +21,7 @@
   <PropertyGroup Label="Globals">
     <ProjectName>SignTool</ProjectName>
     <ProjectGuid>{A1BE9C67-1B56-41BC-A518-76C03C53FCF2}</ProjectGuid>
-    <RootNamespace>KeyGen</RootNamespace>
+    <RootNamespace>SignTool</RootNamespace>
     <Keyword>MFCProj</Keyword>
     <WindowsTargetPlatformVersion>8.1</WindowsTargetPlatformVersion>
   </PropertyGroup>
@@ -252,4 +252,4 @@
       <UserProperties RESOURCE_FILE=".\..\src\TAutoUpdater.rc" />
     </VisualStudio>
   </ProjectExtensions>
-</Project>
+</Project>