-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Darwin] Add MTROTAHeaderParser and use it in darwin-framework-tool (#…
…21235) * [Darwin] Add MTROTAHeaderParser * [darwin-framework-tool] Use MTROTAHeaderParser
- Loading branch information
1 parent
baf750a
commit 2671d45
Showing
8 changed files
with
204 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
/** | ||
* | ||
* Copyright (c) 2022 Project CHIP Authors | ||
* | ||
* 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. | ||
*/ | ||
|
||
#import <Foundation/Foundation.h> | ||
|
||
NS_ASSUME_NONNULL_BEGIN | ||
|
||
typedef NS_ENUM(NSUInteger, MTROTAImageDigestType) { | ||
MTROTAImageDigestTypeSha256 = 1, | ||
MTROTAImageDigestTypeSha256_128, | ||
MTROTAImageDigestTypeSha256_120, | ||
MTROTAImageDigestTypeSha256_96, | ||
MTROTAImageDigestTypeSha256_64, | ||
MTROTAImageDigestTypeSha256_32, | ||
MTROTAImageDigestTypeSha384, | ||
MTROTAImageDigestTypeSha512, | ||
MTROTAImageDigestTypeSha3_224, | ||
MTROTAImageDigestTypeSha3_256, | ||
MTROTAImageDigestTypeSha3_384, | ||
MTROTAImageDigestTypeSha3_512, | ||
}; | ||
|
||
@interface MTROTAHeader : NSObject | ||
|
||
@property (nonatomic, strong) NSNumber * vendorID; | ||
@property (nonatomic, strong) NSNumber * productID; | ||
@property (nonatomic, strong) NSNumber * payloadSize; | ||
@property (nonatomic, strong) NSNumber * softwareVersion; | ||
@property (nonatomic, strong) NSString * softwareVersionString; | ||
@property (nonatomic, strong) NSString * releaseNotesURL; | ||
@property (nonatomic, strong) NSData * imageDigest; | ||
@property (nonatomic, assign) MTROTAImageDigestType imageDigestType; | ||
@property (nonatomic, strong) NSNumber * minApplicableVersion; | ||
@property (nonatomic, strong) NSNumber * maxApplicableVersion; | ||
|
||
@end | ||
|
||
@interface MTROTAHeaderParser : NSObject | ||
+ (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __autoreleasing *)error; | ||
@end | ||
|
||
NS_ASSUME_NONNULL_END |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/** | ||
* | ||
* Copyright (c) 2022 Project CHIP Authors | ||
* | ||
* 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. | ||
*/ | ||
|
||
#import "MTROTAHeaderParser.h" | ||
|
||
#import "MTRError.h" | ||
#import "MTRError_Internal.h" | ||
#import "NSDataSpanConversion.h" | ||
#import "NSStringSpanConversion.h" | ||
|
||
#include <lib/core/OTAImageHeader.h> | ||
|
||
@implementation MTROTAHeader | ||
@end | ||
|
||
@implementation MTROTAHeaderParser | ||
+ (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __autoreleasing *)error | ||
{ | ||
chip::OTAImageHeaderParser parser; | ||
|
||
parser.Init(); | ||
|
||
if (!parser.IsInitialized()) { | ||
*error = [NSError errorWithDomain:MTRErrorDomain code:MTRErrorCodeGeneralError userInfo:nil]; | ||
return nil; | ||
} | ||
|
||
chip::ByteSpan buffer = AsByteSpan(data); | ||
chip::OTAImageHeader header; | ||
CHIP_ERROR err = parser.AccumulateAndDecode(buffer, header); | ||
if (err != CHIP_NO_ERROR) { | ||
*error = [MTRError errorForCHIPErrorCode:err]; | ||
parser.Clear(); | ||
return nil; | ||
} | ||
|
||
auto headerObj = [MTROTAHeader new]; | ||
headerObj.vendorID = @(header.mVendorId); | ||
headerObj.productID = @(header.mProductId); | ||
headerObj.payloadSize = @(header.mPayloadSize); | ||
headerObj.softwareVersion = @(header.mSoftwareVersion); | ||
headerObj.softwareVersionString = AsString(header.mSoftwareVersionString); | ||
headerObj.releaseNotesURL = AsString(header.mReleaseNotesURL); | ||
headerObj.imageDigest = AsData(header.mImageDigest); | ||
headerObj.imageDigestType = static_cast<MTROTAImageDigestType>(chip::to_underlying(header.mImageDigestType)); | ||
|
||
if (header.mMinApplicableVersion.HasValue()) { | ||
headerObj.minApplicableVersion = @(header.mMinApplicableVersion.Value()); | ||
} | ||
|
||
if (header.mMaxApplicableVersion.HasValue()) { | ||
headerObj.maxApplicableVersion = @(header.mMaxApplicableVersion.Value()); | ||
} | ||
|
||
parser.Clear(); | ||
return headerObj; | ||
} | ||
@end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
/** | ||
* Copyright (c) 2022 Project CHIP Authors | ||
* | ||
* 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. | ||
*/ | ||
|
||
#pragma once | ||
|
||
#import "Foundation/Foundation.h" | ||
|
||
#include <lib/support/Span.h> | ||
|
||
NS_ASSUME_NONNULL_BEGIN | ||
|
||
/** | ||
* Utilities for converting between NSString and chip::CharSpan. | ||
*/ | ||
|
||
inline chip::CharSpan AsCharSpan(NSString * str) { return chip::CharSpan([str UTF8String], [str length]); } | ||
|
||
inline NSString * AsString(chip::CharSpan span) | ||
{ | ||
return [[NSString alloc] initWithBytes:span.data() length:span.size() encoding:NSUTF8StringEncoding]; | ||
} | ||
|
||
NS_ASSUME_NONNULL_END |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters